Синглтон (шаблон-одиночка) для Oz SDK.
Инициализирует OZSDK, используя данные лицензии. В качестве замыкания передаются либо данные о лицензии, либо LicenseError.
Возвращает
-
Принудительно устанавливает лицензию.
Запрашивает токен доступа для пользователя.
Возвращает
Токен доступа или ошибку.
Запрашивает токен доступа для отправки телеметрии.
Возвращает
Токен доступа или ошибку.
Проверяет, существует ли токен доступа.
Параметры
-
Возвращает
Результат проверки – true или false.
Удаляет сохраненный токен доступа.
Параметры
-
Возвращает
-
Создает контроллер для проверки Liveness.
Возвращает
UIViewController или исключение.
Создает контроллер для проверки Liveness.
Возвращает
UIViewController или исключение.
Удаляет все видеоролики.
Параметры
-
Возвращает
-
Запрашивает идентификатор сессии телеметрии.
Параметры
-
Возвращает
Идентификатор сессии телеметрии (String).
Устанавливает кастомный бандл, в котором содержатся переводы строк.
Возвращает
-
Устанавливает длительность жеста Селфи (в миллисекундах).
Создает payload с подписями медиафайлов.
Возвращает
payload для загрузки вместе с медиафайлами, для которых он был сгенерирован.
Язык SDK (если язык не указывается, локаль устанавливается автоматически).
Хост, к которому обращается система для проверки Liveness.
Количество попыток выполнения анализов, после которого SDK выдаст ошибку.
Версия SDK.
Делегат OZSDK.
Запрашивает результаты проверки Liveness.
Возвращает
-
Обрабатывает ошибки.
Возвращает
-
Протокол для выполнения проверок.
Создает инстанс AnalysisRequest.
Возвращает
Инстанс AnalysisRequest.
Добавляет в AnalysisRequest анализы.
Возвращает
-
Загружает медиафайл(ы) на сервер.
Возвращает
-
Добавляет идентификатор папки для загрузки на сервер.
Возвращает
-
Добавляет в папку метаданные.
Возвращает
-
Запускает анализы.
Возвращает
Результат проверок или ошибку.
Настройки кастомизации OzLivenessSDK (используйте OZSDK.customization).
Настройки кастомизации верхней панели.
Настройки кастомизации текста подсказки, ориентируясь на который, пользователь снимает фото или видео.
Настройки кастомизации для анимации подсказки.
Настройки кастомизации рамки вокруг лица.
Настройки кастомизации фона за рамкой.
Настройки кастомизации текста версии SDK.
Настройки защиты от мошенников – сообщения, предупреждающего человека о том, что его снимают.
Параметры настройки логотипа, если лицензия предусматривает возможность его изменения.
Источник лицензии.
Полная информация о лицензии
Действие, представленное на видео.
Код языка SDK в соответствии с ISO 639-1.
Содержит информацию о медиафайле.
Тип медиафайла.
Описание ошибки.
Содержит информацию о том, какие анализы и к каким медиафайлам применять.
Тип анализа.
В настоящее время для типа DOCUMENTS режим onDevice не поддерживается.
Режим анализа.
Отображает статус обработки медиафайлов.
Отображает статус загрузки файлов.
Отображает промежуточный результат обработки анализов.
Описывает результат анализа для одного медиафайла.
Сводный результат анализа для всех медиафайлов.
Содержит результат проверок.
Сводный статус по выполненным анализам.
Содержит результаты одиночных анализов.
Форма рамки.
Возможные ошибки лицензирования.
Тип авторизации.
Настройки повторной отправки медиафайлов.
Определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа. По умолчанию отправляется сжатое видео.
| Параметр | Тип | Описание |
|---|---|---|
Параметр
Тип
Описание
licenseSources
Источник лицензии
Параметр
Тип
Описание
licenseSource
Источник лицензии
Параметр
Тип
Описание
apiConnection
Параметры авторизации
Параметр
Тип
Описание
eventsConnection
Параметры авторизации для телеметрии
Параметр
Тип
Описание
delegate
Делегат Oz Liveness
actions
Действие на видео
cameraPosition (опционально)
AVCaptureDevice.Position
front – фронтальная камера (по умолчанию),
back – основная камера
Параметр
Тип
Описание
actions
Действие на видео
FaceCaptureCompletion
type alias
пример использования::
public typealias FaceCaptureCompletion = (_ results: [OZMedia]?, _ error: OZVerificationStatus?) -> Void
Callback-функция, которая вызывается по завершении метода. В качестве замыкания передается либо массив объектов OzMedia, либо ошибка.
cameraPosition (опционально)
AVCaptureDevice.Position
front – фронтальная камера (по умолчанию),
back – основная камера
Параметр
Тип
Описание
languageBundle
Bundle
Бандл для поиска переводов
Параметр
Тип
Описание
selfieLength
Int
Длительность жеста Селфи (в миллисекундах). Должна быть в пределах 500-5000, по умолчанию – 700
Параметр
Тип
Описание
media
Массив медиафайлов
Параметр
Тип
Описание
String
Код локали
Параметр
Тип
Описание
host
String
Адрес хоста
Параметр
Тип
Описание
singleCount
Int
Количество попыток для одного действия/;tcnf
commonCount
Int
Суммарное количество попыток для всех действий/жестов, если используется последовательность (комбо)
faceAlignmentTimeout
Float
Время, в течение которого нужно поместить лицо в рамку
uploadMediaSettings
Настройки повторной отправки медиафайлов
Параметр
Тип
Описание
version
String
Номер версии
Параметр
Тип
Описание
results
[OzMedia]
Массив объектов OzMedia
Параметр
Тип
Описание
status
Описание ошибки
Параметр
Тип
Описание
folderId (опционально)
String
Идентификатор папки; указывается только в том случае, если нужно загрузить файлы в определенную папку
Параметр
Тип
Описание
analysis
Analysis
Структура с информацией об анализах
Параметр
Тип
Описание
media
Объект или массив объектов OzMedia
Параметр
Тип
Описание
folderId
String
Идентификатор папки
Параметр
Тип
Описание
meta
[String]
Массив метаданных; пример:
["meta1": "data1"]
Параметр
Тип
Описание
statusHandler
Callback-функция
statusHandler: @escaping ((_ status: RequestStatus) -> Void)
Вызывается в момент смены состояния метода. В качестве замыкания передается RequestStatus, который показывает статус обработки анализов.
errorHandler
Callback-функция
errorHandler: @escaping ((_ error: Error) -> Void)
Вызывается при возникновении ошибки
completionHandler
Callback-функция
completionHandler: @escaping (_ results : RequestResult) -> Void)
Вызывается по завершении метода. В качестве замыкания передается RequestResult, который содержит информацию о результатах проверок.
Параметр
Тип
Описание
closeButtonIcon
UIImage
Иконка кнопки закрытия
closeButtonColor
UIColor
Цвет кнопки закрытия, tintColor
titleFont
UIFont
Шрифт текста на верхней панели
titleColor
UIColor
Цвет текста на верхней панели
backgroundColor
UIColor
Цвет фона верхней панели
titleText
String
Текст на верхней панели
Параметр
Тип
Описание
textFont
UIFont
Шрифт текста подсказки
textColor
UIColor
Цвет текста подсказки
backgroundColor
UIColor
Цвет фона текста подсказки
verticalPosition
Int
Положение подсказки по вертикали (от верхнего края экрана, в %, 0-100)
hideTextBackground
Bool
Скрывает подложку подсказки
backgroundCornerRadius
Int
Угловой радиус подложки
Параметр
Тип
Описание
hideAnimation
Bool
Переключатель для отображения анимации, значение True скрывает анимацию
animationIconSize
CGfloat
Размер стороны квадрата, в который вписана иконка анимации
hintGradientColor
UIColor
Цвет градиента у рамки
Параметр
Тип
Описание
geometryType
Форма рамки: овал, прямоугольник, круг или квадрат
cornerRadius
CGFloat
Угловой радиус прямоугольника/квадрата (в dp)
strokeFaceNotAlignedColor
UIColor
Цвет рамки, когда лицо не в кадре
strokeFaceAlignedColor
UIColor
Цвет рамки, когда лицо в кадре
strokeWidth
CGFloat
Толщина линии (в dp, 0-20)
strokePadding
CGFloat
Отступ от рамки до овала, куда нужно поместить лицо (в dp, 0-10)
Параметр
Тип
Описание
backgroundColor
UIColor
Цвет фона за рамкой
Параметр
Тип
Описание
textFont
UIFont
Шрифт текста версии SDK
textColor
UIColor
Цвет текста версии SDK
Parameter
Type
Description
customizationEnableAntiscam
Bool
Включает защиту от мошенников
customizationAntiscamTextMessage
String
Текст сообщения
customizationAntiscamTextFont
UIFont
Шрифт текста сообщения
customizationAntiscamTextColor
UIColor
Цвет текста сообщения
customizationAntiscamBackgroundColor
UIColor
Цвет подложки сообщения
customizationAntiscamCornerRadius
CGFloat
Угловой радиус подложки
customizationAntiscamFlashColor
UIColor
Цвет мигающего индикатора рядом с сообщением
Parameter
Type
Description
image
UIImage
Изображение для лого
size
CGSize
Размер лого (в dp)
Значение
Описание
licenseFilePath
Абсолютный путь к лицензии (String)
licenseFileName
Имя файла лицензии
Параметр
Тип
Описание
appIDS
[String]
Массив идентификаторов приложений
expires
TimeInterval
Период времени, спустя который срок действия лицензии истечет
features
Features
Особенности лицензии
configs (опционально)
ABTestingConfigs
Дополнительная конфигурация
Значение
Описание
smile
Улыбка
eyes
Моргание
scanning
Сканирование
selfie
Селфи с проверкой позиционирования лица
one_shot
Лучший кадр из снятого видео
left
Поворот головы налево
right
Поворот головы направо
down
Наклон головы вниз
up
Подъем головы наверх
Значение
Описание
en
Английский
ru
Русский
hy
Армянский
kk
Казахский
ky
Кыргызский
tr
Турецкий
es
Испанский
pt-BR
Португальский (бразильский вариант)
custom(String)
Кастомный язык (код языка ISO 639-1, две буквы)
Параметр
Тип
Описание
movement
Действие на видео
mediaType
Тип медиафайла
metaData
[String]
Метаданные, если есть
videoURL
URL
URL видео с проверкой Liveness
bestShotURL
URL
URL лучшего кадра в формате PNG
preferredMediaURL
URL
URL медиаконтейнера API
timestamp
Date
Время окончания проверки
Значение
Описание
movement
Видео/фото с действием
documentBack
Фото оборотной стороны документа
documentFront
Фото лицевой стороны документа
Значение
Описание
userNotProcessed
Проверка не была обработана
failedBecauseUserCancelled
Проверка была прервана пользователем.
failedBecauseCameraPermissionDenied
Нельзя выполнить проверку из-за отсутствия доступа к камере
failedBecauseOfBackgroundMode
Нельзя выполнить проверку, так как приложение было свернуто
failedBecauseOfTimeout
Нельзя выполнить проверку, так как время, отведенное на проверку, закончилось
failedBecauseOfAttemptLimit
Нельзя выполнить проверку, так как превышен лимит попыток
failedBecausePreparingTimout
Нельзя выполнить проверку, так как время, отведенное на съемку, закончилось
failedBecauseOfLowMemory
Нельзя выполнить проверку, так как не хватает памяти
Параметр
Тип
Описание
media
[OzMedia]
Массив объектов OzMedia
type
Тип анализа
mode
Режим анализа
sizeReductionStrategy
Определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа.
params (опционально)
String
Дополнительные параметры
Значение
Описание
biometry
Позволяет сравнить несколько фото или видео и оценить уровень схожести запечатленных на них людей.
quality
Проверяет наличие живого человека в кадре
document
Определяет наличие документа в кадре и проверяет корректность полей документа согласно его типу.
blacklist
Сравнивает лицо снятого на фото или видео человека с лицами из заранее созданной базы медиафайлов
Значение
Описание
onDevice
Анализ на устройстве
serverBased
Анализ на сервере
hybrid
Гибридный анализ для Liveness: если итоговая оценка анализа на устройстве больше определенного порога, медиафайл дополнительно анализируется на сервере.
Значение
Описание
addToFolder
Система создает папку и помещает в нее медиафайлы
addAnalyses
Система добавляет анализы
waitAnalysisResult
Система ожидает результата
Параметр
Тип
Описание
media
Объект, который загружается в данный момент
index
Int
Номер объекта в списке
from
Int
Количество объектов
progress
Progress
Статус загрузки
Параметр
Тип
Описание
status
Статус обработки анализов
progressStatus
Статус загрузки медиафайла
Параметр
Тип
Описание
resolution
Общий результат анализа
sourceId
String
Идентификатор медиафайла на сервере
isOnDevice
Bool
Режим анализа
confidenceScore
Float
Итоговая оценка
mediaType
String
Тип медиафайла: VIDEO / IMAGE / SHOT_SET
media
Анализируемый медиафайл
error
AnalysisError (наследуется от базового Error)
Ошибка
Параметр
Тип
Описание
resolution
Сводный результат анализов
folderId
String
Идентификатор
analysisResults
Результаты анализов
Параметр
Тип
Описание
resolution
Общий результат анализа
type
Тип анализа
mode
Режим анализа
analysisId
String
Идентификатор анализа
error
AnalysisError (наследуется от базового Error)
Ошибка
resultMedia
Список результатов анализов по отдельным медиафайлам
confidenceScore
Float
Итоговая оценка
serverRawResponse
String
Ответ сервера
Значение
Описание
INITIAL
Анализы не назначались
PROCESSING
Анализы выполняются
FAILED
Один или более анализов не удалось завершить из-за ошибок
FINISHED
Анализы выполнены
DECLINED
Проверка не пройдена (лица не совпадают или замечена спуфинг-атака)
SUCCESS
Проверка успешно пройдена
OPERATOR_REQUIRED
Результат анализов должен быть дополнительно перепроверен оператором
Параметр
Тип
Описание
analyseResolutionStatus
Статус анализа
type
Тип анализа
folderID
String
Идентификатор папки
score
Float
Результат выполненной проверки
Значение
Описание
oval
Овальная рамка
rectangle(cornerRadius: CGFloat)
Прямоугольная рамка (угловой радиус рамки)
circle
Круглая рамка
square(cornerRadius: CGFloat)
Квадратная рамка (угловой радиус рамки)
Case
Description
licenseFileNotFound
Лицензия не найдена
licenseParseError
Невозможно распознать файл лицензии
licenseBundleError
Указанный в лицензииbundle_id не совпадает с используемым bundle_id.
licenseExpired
Срок действия лицензии истек
Значение
Описание
fromServiceToken
Авторизация через токен:
host: String
token: String
fromCredentials
Авторизация через логин и пароль:
host: String
login: String
password: String
attemptsCount
Int
Количество попыток загрузки медиафайла
attemptsTimeout
Int
Интервал времени между попытками
Case
Description
uploadOriginal
Исходное видео
uploadCompressed
Сжатое видео
uploadBestShot
Полученный из видео лучший кадр
uploadNothing
Ничего (в этом случае на сервер не отправляется ничего, папка не создается)