Обзор¶

Пять понятий, которые стоит понимать до начала интеграции.

Заявитель (Applicant)¶

Заявитель — единица хранения статуса проверки: одна запись на одного конечного пользователя. Вы создаёте заявителя под собственным externalUserId, поэтому один и тот же пользователь всегда соответствует одному заявителю в нашей системе. Заявитель имеет тип individual или company и хранит:

поля профиля (имя, дата рождения, адрес, …),
уровень проверки, по которому он проходит верификацию,
статус проверки и уровень риска (результат проверок),
список прикреплённых документов,
журнал аудита.

После создания заявитель — это сущность, которую вы читаете, обновляете, скринингуете и к которой прикрепляете документы. В webhook-событиях заявитель идентифицируется через externalUserId.

Уровень проверки (Verification Level)¶

Уровень проверки — это рецепт «что значит быть верифицированным для этого продукта». Уровень — это настроенная цепочка шагов:

Документ удостоверения личности (паспорт / ID-карта / права),
Селфи / проверка живости,
Анкета (KYC / источник средств / профиль рисков),
AML-скрининг (санкции / PEP / негативные СМИ).

Уровни настраиваются в портале продукта, не во время запроса. У каждого уровня есть короткое стабильное имя (KYC_01, KYB_STANDARD, …) — именно оно используется как идентификатор во всех запросах. Назначить уровень заявителю можно через POST /v1/applicants/{externalUserId}/levels/{levelName}.

Сессия проверки (Verification Session)¶

Сессия проверки — это одна хостируемая попытка пройти все шаги, которые требует уровень заявителя. Вы создаёте сессию через POST /v1/applicants/{externalUserId}/verification-sessions и получаете:

{
  "url": "https://sdk.your-platform.example/?token=…",
  "expiresAt": "2026-04-30T10:00:00Z"
}

Перенаправьте пользователя по url. Он пройдёт все шаги в хостируемом интерфейсе (камера, форма, анкета) и вернётся на ваш сайт по завершении.

Токен — внутренняя деталь URL, ваш клиент никогда не работает с ним напрямую.

Срабатывание скрининга (Screening Hit)¶

Срабатывание скрининга — это совпадение, возвращаемое запросами /v1/screening/*. Для каждого кандидата возвращается оценка совпадения, источник и любые отметки PEP / санкций / негативных СМИ. Используйте для углублённой проверки (EDD) или перечисления бенефициарных владельцев корпоративного заявителя.

Webhook-событие¶

Webhook-событие — это JSON-полезная нагрузка, которую мы отправляем POST-запросом на ваш зарегистрированный URL-приёмник, когда что-то происходит с заявителем: верификация завершена, статус изменился, найдено срабатывание скрининга и т.п. Каждое событие подписано HMAC, чтобы вы могли проверить, что оно пришло от нас. См. Интеграция вебхуков.