For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reference

This is the canonical bilingual glossary for OneKYC. Each entry pairs the English term with its Russian counterpart, a definition in both languages, the API field (when one exists), and links to related concepts.

Disambiguation: when one English word maps to two distinct concepts (for example, Session (verification) vs. Session (admin login)), each is a separate entry with explicit cross-references.


AML screening

RU: AML-проверка / AML-скрининг Definition (EN): Automated check of an applicant against sanctions lists, PEP databases, and other watch-lists. The result is recorded against the verification session. Definition (RU): Автоматическая проверка аппликанта по санкционным спискам, базам PEP и иным watch-листам. Результат фиксируется в сессии верификации. API field: aml_status, aml_match_count Related: PEP, sanctions, verification session

AML

RU: AML Definition (EN): Anti-Money Laundering — controls aimed at preventing money laundering. In OneKYC the term refers to automated AML screening. Definition (RU): Anti-Money Laundering, противодействие отмыванию денежных средств. В OneKYC означает автоматический AML-скрининг. Related: AML screening, sanctions, PEP

API key

RU: API-ключ Definition (EN): A key + secret pair used to authenticate your backend against the Tenant API. The key id is sent in a request header; the request body is signed with HMAC using the secret. Definition (RU): Пара «ключ + секрет» для аутентификации вашего бэкенда в Tenant API. Идентификатор ключа передаётся в заголовке запроса; тело запроса подписывается HMAC с использованием секрета. API field: api_key_id, headers Authorization and X-Timestamp Related: scope, HMAC, secret rotation

Applicant

RU: Аппликант Definition (EN): An individual undergoing or having completed KYC verification. In the API and admin panel, an applicant is identified by an internal id or by your system's external user identifier. Definition (RU): Физическое лицо, проходящее или завершившее KYC-верификацию. В API и админ-панели аппликант идентифицируется по внутреннему ID или по внешнему идентификатору вашей системы. API field: applicant_id (UUID v4), external_user_id Related: session, business, flow

Audit log

RU: Журнал аудита Definition (EN): A chronological record of every action performed by users and API keys: sign-ins, configuration changes, verification decisions, secret rotations. Definition (RU): Хронологический журнал всех действий пользователей и API-ключей: входы, изменения конфигурации, решения по верификации, ротации секретов. API field: audit_log_id Related: action, retention

Beneficial owner (UBO)

RU: Бенефициар Definition (EN): A natural person who ultimately owns or controls a business undergoing KYB verification. Identification of UBOs is one of the KYB checks. The full Russian form "Бенефициарный владелец" is acceptable in formal headings; "Бенефициар" is the canonical surface form everywhere else. Definition (RU): Физическое лицо, которое в конечном счёте владеет или контролирует бизнес, проходящий KYB. Идентификация бенефициаров — одна из KYB-проверок. API field: beneficial_owners[] Related: KYB, business

Business

RU: Бизнес Definition (EN): A legal entity (company, sole proprietor) undergoing KYB verification. The KYB equivalent of an applicant. Definition (RU): Юридическое лицо (компания, ИП), проходящее KYB-верификацию. Аналог аппликанта в KYB. API field: business_id (UUID v4) Related: KYB, beneficial owner, verification session

BYOB

RU: BYOB Definition (EN): Bring-your-own-bucket — a feature that lets a tenant connect its own S3 / S3-compatible / GCS / Azure Blob storage to OneKYC instead of using the shared OneKYC bucket. Definition (RU): Bring-Your-Own-Bucket — возможность подключить собственный S3 / S3-совместимый / GCS / Azure Blob-стораж тенанта вместо общего хранилища OneKYC. Related: tenant, S3, storage migration

Cross-device handoff

RU: Передача на другое устройство Definition (EN): A flow capability that lets the user continue verification on another device (typically scanning a QR code on a mobile to capture documents and selfies). Definition (RU): Возможность флоу продолжить верификацию на другом устройстве (как правило, сканированием QR-кода с мобильного для съёмки документов и селфи). Related: QR code, verification link

Dead letter queue (DLQ)

RU: Очередь недоставленных сообщений (DLQ) Definition (EN): A holding queue for webhook events that exhausted every automatic delivery attempt. Items can be retried, deleted, or bulk-replayed once the receiver is restored. Definition (RU): Очередь, в которую попадают вебхук-события после исчерпания всех автоматических попыток доставки. Записи можно отправить повторно, удалить или массово воспроизвести после восстановления приёмника. Related: webhook, retry policy

Document

RU: Документ Definition (EN): An identity document (passport, ID card, driving licence, etc.) uploaded during verification. Subject to OCR, document authenticity, and document-liveness checks. Definition (RU): Документ, удостоверяющий личность (паспорт, ID-карта, водительские права и т. д.), загруженный в ходе верификации. Подлежит OCR, проверкам подлинности и document liveness. API field: document_id, document_type Related: OCR, document liveness

Document liveness

RU: Document liveness Definition (EN): Verification that a real physical document is being captured by the camera, not a photograph or screen reproduction. Definition (RU): Проверка, что перед камерой находится реальный физический документ, а не фотография или экран. API field: document_liveness_status Related: liveness, face liveness, KBY-AI

Encryption (envelope)

RU: Шифрование (envelope) Definition (EN): A two-tier encryption scheme: a per-tenant Data Encryption Key (DEK) is derived from a master key and protects the actual ciphertext. Used for BYOB credentials. Definition (RU): Двухуровневая схема: Data Encryption Key (DEK) на тенанта выводится из мастер-ключа и шифрует фактический ciphertext. Применяется для BYOB-credentials. Related: BYOB, KMS

External user ID

RU: Внешний ID пользователя Definition (EN): The user identifier in your system, used to bind a verification session to a specific applicant on your side. Definition (RU): Идентификатор пользователя в вашей системе, используемый для привязки сессии верификации к конкретному аппликанту на вашей стороне. API field: external_user_id Related: applicant, verification link

Face liveness

RU: Face liveness Definition (EN): Verification that the person in front of the camera is a real, live human and not a photograph, video replay, or digital deepfake. Definition (RU): Проверка, что перед камерой реальный живой человек, а не фотография, видеозапись или цифровой дипфейк. API field: face_liveness_status Related: liveness, document liveness, selfie

Face match

RU: Сопоставление лица Definition (EN): Automated check that the face on the selfie matches the face on the document photo. The result is a numeric similarity score. Definition (RU): Автоматическая проверка соответствия лица на селфи лицу на фотографии в документе. Результат — числовой similarity score. API field: face_match_similarity Related: selfie, document, KBY-AI

Flow

RU: Флоу Definition (EN): A verification flow — an ordered set of steps that the user goes through (document upload, selfie capture, liveness, OTP entry, etc.). A flow defines the verification scenario. Definition (RU): Сценарий верификации — упорядоченный набор шагов, которые проходит пользователь (загрузка документа, съёмка селфи, liveness, ввод OTP и др.). API field: flow_id, flow_version Related: step, session, flow template

Flow template

RU: Шаблон флоу Definition (EN): A pre-built flow configuration that can be cloned to start a new flow without designing it from scratch. Definition (RU): Заготовленная конфигурация флоу, которую можно клонировать для создания нового флоу без проектирования с нуля. Related: flow

Grace period

RU: Период грации Definition (EN): A configurable interval during which both old and new versions of a secret (or storage location) are accepted, so integrations can switch over without losing requests. Definition (RU): Настраиваемый интервал, в течение которого принимаются и старая, и новая версия секрета (или местоположения хранения), чтобы интеграции могли переключиться без потери запросов. Related: secret rotation, BYOB

HMAC

RU: HMAC Definition (EN): Hash-based Message Authentication Code — a hash-based mechanism for authenticating messages. Used to sign Tenant API requests and verify webhook authenticity with a shared secret. Definition (RU): Hash-based Message Authentication Code — механизм аутентификации сообщений на основе хеша. Используется для подписания запросов к Tenant API и проверки подлинности вебхуков общим секретом. Related: API key, webhook secret, signature

KBY-AI

RU: KBY-AI Definition (EN): Third-party vendor providing OCR, document-authenticity, document-liveness, face-liveness, and face-match services. Definition (RU): Сторонний вендор, поставляющий OCR, проверки подлинности документов, document liveness, face liveness и face match. Related: OCR, document liveness, face liveness, face match

KMS

RU: KMS Definition (EN): Key Management Service — a cloud key-management service (AWS KMS, GCP KMS). For BYOB on AWS, an SSE-KMS bucket policy can require object encryption with the tenant's KMS key. Definition (RU): Key Management Service — сервис управления ключами (AWS KMS, GCP KMS). Для BYOB на AWS политика SSE-KMS может требовать шифрования объектов KMS-ключом тенанта. Related: BYOB, encryption

Kontur.Compliance

RU: Kontur.Compliance (Фокус.Комплаенс) Definition (EN): Third-party AML provider (Russian-language watch-list aggregator) used for sanctions, PEP, and other lists. Definition (RU): Сторонний AML-провайдер (агрегатор русскоязычных watch-листов), используемый для проверки по санкциям, PEP и другим спискам. Related: AML screening

Kontur.Focus

RU: Kontur.Focus (Фокус API) Definition (EN): Third-party data-enrichment provider for Russian companies and individuals registry data. Definition (RU): Сторонний провайдер обогащения данных по российским компаниям и физлицам. Related: enrichment, KYB

KYB

RU: KYB Definition (EN): Know Your Business — the process of verifying a legal entity. Includes verifying company data, beneficial owners, and related parties. Definition (RU): Know Your Business — процедура верификации юридического лица. Включает проверку данных компании, бенефициарных владельцев и связанных лиц. API field: path prefix /tenant/v1/kyb/ Related: KYC, business, beneficial owner

KYC

RU: KYC Definition (EN): Know Your Customer — the process of identifying and verifying a customer's identity. The core OneKYC process: document checks, biometrics, AML screening, and other steps based on the configured flow. Definition (RU): Know Your Customer — процедура идентификации и верификации личности клиента. Основной процесс OneKYC: проверка документов, биометрия, AML-скрининг и другие шаги по настроенному сценарию. API field: path prefix /tenant/v1/kyc/ Related: KYB, applicant, flow

Liveness

RU: Liveness Definition (EN): A live-presence check — confirmation that a real human (or a real document) is in front of the camera. Splits into face liveness and document liveness. Definition (RU): Проверка «живого присутствия» — подтверждение того, что перед камерой реальный человек (или реальный документ). Делится на face liveness и document liveness. Related: face liveness, document liveness

Manual review

RU: Ручная проверка / Ревью Definition (EN): A queue of verification sessions awaiting a human decision. Reviewers inspect documents and applicant data, then approve, reject, or request a resubmit. Definition (RU): Очередь сессий верификации, требующих решения оператора. Ревьюеры просматривают документы и данные аппликанта, затем одобряют, отклоняют или запрашивают пересдачу. API field: admin path prefix /admin/v1/review/tasks; tenant B2B prefixes /tenant/v1/kyc/review-tasks and /tenant/v1/kyb/review-tasks Related: review task, resubmit request

OCR

RU: OCR Definition (EN): Optical Character Recognition — automated extraction of textual fields (full name, date of birth, document number, etc.) from a document image. Definition (RU): Optical Character Recognition — автоматическое извлечение текстовых полей (ФИО, дата рождения, номер документа и т. д.) из изображения документа. API field: ocr_data Related: document, KBY-AI

OTP

RU: OTP Definition (EN): One-Time Password — a one-time code sent to the user via SMS or email to confirm ownership of the supplied phone number or email address. Definition (RU): One-Time Password — одноразовый код, отправляемый пользователю по SMS или email для подтверждения владения номером телефона или адресом электронной почты. Related: SMS, email verification

PEP

RU: PEP Definition (EN): Politically Exposed Person — an individual entrusted with a prominent public function. PEP status is one of the AML-screening lists. Definition (RU): Politically Exposed Person — публичное должностное лицо. PEP-статус — один из списков AML-скрининга. Related: AML screening, sanctions

Presigned URL

RU: Presigned URL Definition (EN): A short-lived signed URL that grants a specific operation (typically GET or POST) on a specific object in object storage. OneKYC uses presigned URLs for document download and direct browser uploads. Definition (RU): Кратковременный подписанный URL, разрешающий конкретную операцию (как правило, GET или POST) над конкретным объектом в object-storage. OneKYC использует presigned URLs для скачивания документов и прямой загрузки из браузера. Related: S3, BYOB

Rate limit

RU: Rate limit Definition (EN): A cap on the number of API requests per unit of time. When the cap is exceeded, requests are rejected with 429 Too Many Requests. Definition (RU): Ограничение количества запросов к API в единицу времени. При превышении лимита запросы отклоняются с кодом 429 Too Many Requests. API field: header Retry-After Related: API key, error codes

Redirect URL

RU: Redirect URL Definition (EN): The address the user is redirected to after verification finishes. Set on the verification link; the completion-screen behaviour (button or automatic redirect) is configured on the flow. Definition (RU): Адрес, на который пользователь перенаправляется после завершения верификации. Указывается на ссылке верификации; поведение экрана завершения (кнопка или автоматический редирект) настраивается на флоу. API field: redirect_url Related: verification link, flow

Rejection vs decline (decision verbs)

RU: Отклонение vs отказ Definition (EN): OneKYC distinguishes two decision verbs by decision authority, not as synonyms:

  • declined / "Declined" — system-driven outcome at the AML stage. The platform refuses the applicant based on a watchlist or sanctions hit. The applicant is never told the specific reason directly; the verb describes a posture, not a person's choice.

  • rejected / "Rejected" — operator-driven manual review outcome. A reviewer actively read the case and pushed reject. The verb describes ownership of the decision.

This split is intentional. It surfaces in admin EN labels (AML stage = "Declined", manual review = "Rejected") and in audit log verbs. Public webhook event names use verification.declined for the final declined/rejected verification outcome. Related: AML screening, manual review, rejection reason

Rejection reason

RU: Причина отклонения Definition (EN): A structured code returned by the reviewer (or by an automated check) to explain why a verification was rejected. Definition (RU): Структурированный код, который возвращает ревьюер (или автоматическая проверка), чтобы объяснить, почему верификация отклонена. API field: rejection_reason Related: review, manual review

Resubmit request

RU: Запрос пересдачи Definition (EN): A request from a reviewer asking the user to retake one specific step (for example, the document photo) without rejecting the entire session. Subject to limits (≤ 3 per session) and a 7-day TTL. Definition (RU): Запрос от ревьюера к пользователю на повторную сдачу одного конкретного шага (например, фото документа) без отклонения всей сессии. Подчиняется лимитам (≤ 3 на сессию) и TTL 7 дней. API field: request_id, reason_code Related: manual review, review task

Review task

RU: Задача ревью Definition (EN): A unit of work in the manual review queue, bound to one verification session. Carries assignment, priority, comments, decision, and a history of resubmit requests. Definition (RU): Единица работы в очереди ручного ревью, привязанная к одной сессии верификации. Содержит назначение, приоритет, комментарии, решение и историю запросов пересдачи. API field: task_id Related: manual review, resubmit request

S3

RU: S3 Definition (EN): Amazon Simple Storage Service, or any S3-compatible object storage (Cloudflare R2, Backblaze B2, MinIO, Wasabi). Used for storing documents, selfies, and KYB materials. Definition (RU): Amazon Simple Storage Service, либо любое S3-совместимое объектное хранилище (Cloudflare R2, Backblaze B2, MinIO, Wasabi). Используется для хранения документов, селфи и KYB-материалов. Related: BYOB, presigned URL

Sanctions

RU: Санкции Definition (EN): Restrictive measures imposed by states or international bodies on individuals and entities. Sanctions matching is one of the AML-screening lists. Definition (RU): Ограничительные меры государств или международных органов в отношении физических и юридических лиц. Соответствие санкциям — один из списков AML-скрининга. Related: AML screening, PEP

Scope

RU: Scope Definition (EN): A permission attached to an API key that grants access to a specific resource or operation (for example, applicants:read, sessions:create). Each endpoint requires one or more scopes. Definition (RU): Право, привязанное к API-ключу, которое даёт доступ к конкретному ресурсу или операции (например, applicants:read, sessions:create). Каждый эндпоинт требует одного или нескольких scopes. Related: API key, permission

Selfie

RU: Селфи Definition (EN): A self-portrait photo or video captured during verification. Used for face liveness and face matching against the document photo. Definition (RU): Автопортретное фото или видео, снятое в ходе верификации. Используется для face liveness и сопоставления с фотографией в документе. API field: selfie_id Related: face liveness, face match

Session (admin login)

RU: Сессия (вход администратора) Definition (EN): An authenticated session in the admin panel — the period between sign-in and sign-out / token expiry. Distinct from a verification session. Definition (RU): Аутентифицированная сессия в админ-панели — период между входом и выходом / истечением токена. Не путать с verification session. API field: JWT cookie / token Related: admin panel, JWT, verification session

Session (verification)

RU: Сессия (верификации) Definition (EN): A single verification process: the user opens a link, walks through the flow steps, and the session ends in approval, rejection, or expiry. Each session has a unique id, a status, and bindings to a flow and an applicant. Definition (RU): Единичный процесс верификации: пользователь открывает ссылку, проходит шаги флоу, сессия завершается одобрением, отклонением или истечением срока. У каждой сессии уникальный ID, статус, привязка к флоу и аппликанту. API field: session_id (UUID v4), status Related: flow, applicant, step, session (admin login)

Step

RU: Шаг Definition (EN): A single stage of the verification flow: document upload, selfie capture, liveness, OTP, data review, and others. Steps may be visible (require user action) or hidden (run automatically after the previous step finishes). Definition (RU): Отдельный этап флоу: загрузка документа, съёмка селфи, liveness, OTP, ревью данных и др. Шаги бывают видимыми (требуют действия пользователя) и скрытыми (выполняются автоматически после завершения предыдущего шага). API field: step_id, step_type Related: flow, session

Storage migration

RU: Миграция хранилища Definition (EN): The background process that copies historical files from OneKYC's shared storage into the tenant's BYOB bucket after BYOB activation. Definition (RU): Фоновый процесс, копирующий исторические файлы из общего хранилища OneKYC в бакет тенанта после активации BYOB. Related: BYOB

Team

RU: Команда Definition (EN): The set of users who have access to the tenant's admin panel. Managed in the Team section: invitations, role assignment, removal, password reset. Definition (RU): Набор пользователей с доступом к админ-панели тенанта. Управляется в разделе «Команда»: приглашения, назначение ролей, удаление, сброс пароля. Related: role, permission

Tenant

RU: Тенант Definition (EN): An organisation (company, project) inside OneKYC. Each tenant's data is fully isolated: sessions, applicants, flows, API keys. Each tenant has its own admin panel and team. Definition (RU): Организация (компания, проект) в системе OneKYC. Данные каждого тенанта полностью изолированы: сессии, аппликанты, флоу, API-ключи. У каждого тенанта своя админ-панель и состав пользователей. API field: tenant_id (UUID v4) Related: team, BYOB, multi-tenancy

RU: Ссылка верификации Definition (EN): A short-lived link used by the user to start verification. Bound to a flow; activating the link creates a verification session. Created in the Verification links section or through the Tenant API. Definition (RU): Кратковременная ссылка, по которой пользователь начинает верификацию. Привязана к флоу; активация ссылки создаёт сессию верификации. Создаётся в разделе «Ссылки верификации» или через Tenant API. API field: link_id, short_code Related: flow, session, redirect URL

Webhook

RU: Вебхук Definition (EN): An HTTP notification OneKYC sends to a URL you provide when a specific event happens (session created, step completed, verification approved or rejected). Requests are signed for authenticity. Endpoints are configured in the Webhooks section. Definition (RU): HTTP-уведомление, которое OneKYC отправляет на указанный вами URL при наступлении события (создание сессии, завершение шага, одобрение или отклонение верификации). Запросы подписываются для проверки подлинности. Эндпоинты настраиваются в разделе «Вебхуки». API field: webhook_endpoint_id, header X-Onekyc-Signature Related: HMAC, dead letter queue, retry policy

Webhook secret

RU: Секрет вебхука Definition (EN): A string with a whsec_ prefix used to sign webhook payloads. Verifying the signature on your side proves the request came from OneKYC. Definition (RU): Строка с префиксом whsec_, которой подписываются payload'ы вебхуков. Проверка подписи на вашей стороне доказывает, что запрос пришёл от OneKYC. Related: webhook, HMAC, secret rotation

Last updated