Методы и поля iOS SDK
OZSDK
Синглтон (шаблон-одиночка) для Oz SDK.
Методы
OZSDK
Инициализирует OZSDK, используя данные лицензии. В качестве замыкания передаются либо данные о лицензии, либо LicenseError.
Параметр
Тип
Описание
Возвращает
-
setLicense
Принудительно устанавливает лицензию.
Параметр
Тип
Описание
setApiConnection
Запрашивает токен доступа для пользователя.
Параметр
Тип
Описание
Возвращает
Токен доступа или ошибку.
setEventsConnection
Запрашивает токен доступа для отправки телеметрии.
Параметр
Тип
Описание
Возвращает
Токен доступа или ошибку.
isLoggedIn
Проверяет, существует ли токен доступа.
Параметры
-
Возвращает
Результат проверки – true или false.
logout
Удаляет сохраненный токен доступа.
Параметры
-
Возвращает
-
createVerificationVCWithDelegate
Создает контроллер для проверки Liveness.
Параметр
Тип
Описание
cameraPosition (опционально)
AVCaptureDevice.Position
front – фронтальная камера (по умолчанию),
back – основная камера
Возвращает
UIViewController или исключение.
createVerificationVC
Создает контроллер для проверки Liveness.
Параметр
Тип
Описание
FaceCaptureCompletion
type alias
пример использования::
public typealias FaceCaptureCompletion = (_ results: [OZMedia]?, _ error: OZVerificationStatus?) -> Void
Callback-функция, которая вызывается по завершении метода. В качестве замыкания передается либо массив объектов OzMedia, либо ошибка.
cameraPosition (опционально)
AVCaptureDevice.Position
front – фронтальная камера (по умолчанию),
back – основная камера
Возвращает
UIViewController или исключение.
cleanTempDirectory
Удаляет все видеоролики.
Параметры
-
Возвращает
-
getEventSessionId
Запрашивает идентификатор сессии телеметрии.
Параметры
-
Возвращает
Идентификатор сессии телеметрии (String).
set
Устанавливает кастомный бандл, в котором содержатся переводы строк.
Параметр
Тип
Описание
languageBundle
Bundle
Бандл для поиска переводов
Возвращает
-
setSelfieLength
Устанавливает длительность жеста Селфи (в миллисекундах).
Параметр
Тип
Описание
selfieLength
Int
Длительность жеста Селфи (в миллисекундах). Должна быть в пределах 500-5000, по умолчанию – 700
generateSignedPayload
Создает payload с подписями медиафайлов.
Возвращает
payload для загрузки вместе с медиафайлами, для которых он был сгенерирован.
Поля
localizationCode
Язык SDK (если язык не указывается, локаль устанавливается автоматически).
Параметр
Тип
Описание
host
Хост, к которому обращается система для проверки Liveness.
Параметр
Тип
Описание
host
String
Адрес хоста
attemptSettings
Количество попыток выполнения анализов, после которого SDK выдаст ошибку.
Параметр
Тип
Описание
singleCount
Int
Количество попыток для одного действия/;tcnf
commonCount
Int
Суммарное количество попыток для всех действий/жестов, если используется последовательность (комбо)
faceAlignmentTimeout
Float
Время, в течение которого нужно поместить лицо в рамку
version
Версия SDK.
Параметр
Тип
Описание
version
String
Номер версии
OZLivenessDelegate
Делегат OZSDK.
Методы
onOZLivenessResult
Запрашивает результаты проверки Liveness.
Параметр
Тип
Описание
Возвращает
-
onError
Обрабатывает ошибки.
Параметр
Тип
Описание
Возвращает
-
AnalysisRequest
Протокол для выполнения проверок.
Методы
AnalysisRequestBuilder
Создает инстанс AnalysisRequest.
Параметр
Тип
Описание
folderId (опционально)
String
Идентификатор папки; указывается только в том случае, если нужно загрузить файлы в определенную папку
Возвращает
Инстанс AnalysisRequest.
addAnalysis
Добавляет в AnalysisRequest анализы.
Параметр
Тип
Описание
analysis
Analysis
Структура с информацией об анализах
Возвращает
-
uploadMedia
Загружает медиафайл(ы) на сервер.
Параметр
Тип
Описание
Возвращает
-
addFolderId
Добавляет идентификатор папки для загрузки на сервер.
Параметр
Тип
Описание
folderId
String
Идентификатор папки
Возвращает
-
addFolderMeta
Добавляет в папку метаданные.
Параметр
Тип
Описание
meta
[String]
Массив метаданных; пример:
["meta1": "data1"]
Возвращает
-
run
Запускает анализы.
Параметр
Тип
Описание
statusHandler
Callback-функция
statusHandler: @escaping ((_ status: RequestStatus) -> Void)
Вызывается в момент смены состояния метода. В качестве замыкания передается RequestStatus, который показывает статус обработки анализов.
errorHandler
Callback-функция
errorHandler: @escaping ((_ error: Error) -> Void)
Вызывается при возникновении ошибки
completionHandler
Callback-функция
completionHandler: @escaping (_ results : RequestResult) -> Void)
Вызывается по завершении метода. В качестве замыкания передается RequestResult, который содержит информацию о результатах проверок.
Возвращает
Результат проверок или ошибку.
Customization
Настройки кастомизации OzLivenessSDK (используйте OZSDK.customization).
toolbarCustomization
Настройки кастомизации верхней панели.
Параметр
Тип
Описание
closeButtonIcon
UIImage
Иконка кнопки закрытия
closeButtonColor
UIColor
Цвет кнопки закрытия, tintColor
titleFont
UIFont
Шрифт текста на верхней панели
titleColor
UIColor
Цвет текста на верхней панели
backgroundColor
UIColor
Цвет фона верхней панели
titleText
String
Текст на верхней панели
centerHintCustomization
Настройки кастомизации текста подсказки, ориентируясь на который, пользователь снимает фото или видео.
Параметр
Тип
Описание
textFont
UIFont
Шрифт текста подсказки
textColor
UIColor
Цвет текста подсказки
backgroundColor
UIColor
Цвет фона текста подсказки
verticalPosition
Int
Положение подсказки по вертикали (от верхнего края экрана, в %, 0-100)
hideTextBackground
Bool
Скрывает подложку подсказки
backgroundCornerRadius
Int
Угловой радиус подложки
hintAnimationCustomization
Настройки кастомизации для анимации подсказки.
Параметр
Тип
Описание
hideAnimation
Bool
Переключатель для отображения анимации, значение True скрывает анимацию
animationIconSize
CGfloat
Размер стороны квадрата, в который вписана иконка анимации
hintGradientColor
UIColor
Цвет градиента у рамки
faceFrameCustomization
Настройки кастомизации рамки вокруг лица.
Параметр
Тип
Описание
cornerRadius
CGFloat
Угловой радиус прямоугольника/квадрата (в dp)
strokeFaceNotAlignedColor
UIColor
Цвет рамки, когда лицо не в кадре
strokeFaceAlignedColor
UIColor
Цвет рамки, когда лицо в кадре
strokeWidth
CGFloat
Толщина линии (в dp, 0-20)
strokePadding
CGFloat
Отступ от рамки до овала, куда нужно поместить лицо (в dp, 0-10)
backgroundCustomization
Настройки кастомизации фона за рамкой.
Параметр
Тип
Описание
backgroundColor
UIColor
Цвет фона за рамкой
versionCustomization
Настройки кастомизации текста версии SDK.
Параметр
Тип
Описание
textFont
UIFont
Шрифт текста версии SDK
textColor
UIColor
Цвет текста версии SDK
antiscamCustomization
Настройки защиты от мошенников – сообщения, предупреждающего человека о том, что его снимают.
Parameter
Type
Description
customizationEnableAntiscam
Bool
Включает защиту от мошенников
customizationAntiscamTextMessage
String
Текст сообщения
customizationAntiscamTextFont
UIFont
Шрифт текста сообщения
customizationAntiscamTextColor
UIColor
Цвет текста сообщения
customizationAntiscamBackgroundColor
UIColor
Цвет подложки сообщения
customizationAntiscamCornerRadius
CGFloat
Угловой радиус подложки
customizationAntiscamFlashColor
UIColor
Цвет мигающего индикатора рядом с сообщением
logoCustomization
Параметры настройки логотипа, если лицензия предусматривает возможность его изменения.
Parameter
Type
Description
image
UIImage
Изображение для лого
size
CGSize
Размер лого (в dp)
Переменные и объекты
enum LicenseSource
Источник лицензии.
Значение
Описание
licenseFilePath
Абсолютный путь к лицензии (String)
licenseFileName
Имя файла лицензии
struct LicenseData
Полная информация о лицензии
Параметр
Тип
Описание
appIDS
[String]
Массив идентификаторов приложений
expires
TimeInterval
Период времени, спустя который срок действия лицензии истечет
features
Features
Особенности лицензии
configs (опционально)
ABTestingConfigs
Дополнительная конфигурация
enum OzVerificationMovement
Действие, представленное на видео.
Значение
Описание
smile
Улыбка
eyes
Моргание
scanning
Сканирование
selfie
Селфи с проверкой позиционирования лица
one_shot
Лучший кадр из снятого видео
left
Поворот головы налево
right
Поворот головы направо
down
Наклон головы вниз
up
Подъем головы наверх
enum OZLocalizationCode
Код языка SDK в соответствии с ISO 639-1.
Значение
Описание
en
Английский
ru
Русский
hy
Армянский
kk
Казахский
ky
Кыргызский
tr
Турецкий
es
Испанский
pt-BR
Португальский (бразильский вариант)
custom(String)
Кастомный язык (код языка ISO 639-1, две буквы)
struct OZMedia
Содержит информацию о медиафайле.
Параметр
Тип
Описание
metaData
[String]
Метаданные, если есть
videoURL
URL
URL видео с проверкой Liveness
bestShotURL
URL
URL лучшего кадра в формате PNG
preferredMediaURL
URL
URL медиаконтейнера API
timestamp
Date
Время окончания проверки
enum MediaType
Тип медиафайла.
Значение
Описание
movement
Видео/фото с действием
documentBack
Фото оборотной стороны документа
documentFront
Фото лицевой стороны документа
enum OZVerificationStatus
Описание ошибки.
Значение
Описание
userNotProcessed
Проверка не была обработана
failedBecauseUserCancelled
Проверка была прервана пользователем.
failedBecauseCameraPermissionDenied
Нельзя выполнить проверку из-за отсутствия доступа к камере
failedBecauseOfBackgroundMode
Нельзя выполнить проверку, так как приложение было свернуто
failedBecauseOfTimeout
Нельзя выполнить проверку, так как время, отведенное на проверку, закончилось
failedBecauseOfAttemptLimit
Нельзя выполнить проверку, так как превышен лимит попыток
failedBecausePreparingTimout
Нельзя выполнить проверку, так как время, отведенное на съемку, закончилось
failedBecauseOfLowMemory
Нельзя выполнить проверку, так как не хватает памяти
struct Analysis
Содержит информацию о том, какие анализы и к каким медиафайлам применять.
Параметр
Тип
Описание
sizeReductionStrategy
Определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа.
params (опционально)
String
Дополнительные параметры
enum AnalysisType
Тип анализа.
Значение
Описание
biometry
Позволяет сравнить несколько фото или видео и оценить уровень схожести запечатленных на них людей.
quality
Проверяет наличие живого человека в кадре
document
Определяет наличие документа в кадре и проверяет корректность полей документа согласно его типу.
blacklist
Сравнивает лицо снятого на фото или видео человека с лицами из заранее созданной базы медиафайлов
В настоящее время для типа DOCUMENTS режим onDevice не поддерживается.
enum AnalysisMode
Режим анализа.
Значение
Описание
onDevice
Анализ на устройстве
serverBased
Анализ на сервере
hybrid
Гибридный анализ для Liveness: если итоговая оценка анализа на устройстве больше определенного порога, медиафайл дополнительно анализируется на сервере.
enum ScenarioState
Отображает статус обработки медиафайлов.
Значение
Описание
addToFolder
Система создает папку и помещает в нее медиафайлы
addAnalyses
Система добавляет анализы
waitAnalysisResult
Система ожидает результата
struct AnalysisStatus
Отображает статус загрузки файлов.
Параметр
Тип
Описание
index
Int
Номер объекта в списке
from
Int
Количество объектов
progress
Progress
Статус загрузки
RequestStatus
Отображает промежуточный результат обработки анализов.
Параметр
Тип
Описание
ResultMedia
Описывает результат анализа для одного медиафайла.
Параметр
Тип
Описание
sourceId
String
Идентификатор медиафайла на сервере
isOnDevice
Bool
Режим анализа
confidenceScore
Float
Итоговая оценка
mediaType
String
Тип медиафайла: VIDEO / IMAGE / SHOT_SET
error
AnalysisError (наследуется от базового Error)
Ошибка
RequestResult
Сводный результат анализа для всех медиафайлов.
Параметр
Тип
Описание
folderId
String
Идентификатор
class AnalysisResult
Содержит результат проверок.
Параметр
Тип
Описание
analysisId
String
Идентификатор анализа
error
AnalysisError (наследуется от базового Error)
Ошибка
confidenceScore
Float
Итоговая оценка
serverRawResponse
String
Ответ сервера
enum AnalyseResolutionStatus
Сводный статус по выполненным анализам.
Значение
Описание
INITIAL
Анализы не назначались
PROCESSING
Анализы выполняются
FAILED
Один или более анализов не удалось завершить из-за ошибок
FINISHED
Анализы выполнены
DECLINED
Проверка не пройдена (лица не совпадают или замечена спуфинг-атака)
SUCCESS
Проверка успешно пройдена
OPERATOR_REQUIRED
Результат анализов должен быть дополнительно перепроверен оператором
struct AnalyseResolution
Содержит результаты одиночных анализов.
Параметр
Тип
Описание
folderID
String
Идентификатор папки
score
Float
Результат выполненной проверки
enum GeometryType
Форма рамки.
Значение
Описание
oval
Овальная рамка
rectangle(cornerRadius: CGFloat)
Прямоугольная рамка (угловой радиус рамки)
circle
Круглая рамка
square(cornerRadius: CGFloat)
Квадратная рамка (угловой радиус рамки)
enum LicenseError
Возможные ошибки лицензирования.
Case
Description
licenseFileNotFound
Лицензия не найдена
licenseParseError
Невозможно распознать файл лицензии
licenseBundleError
Указанный в лицензииbundle_id не совпадает с используемым bundle_id.
licenseExpired
Срок действия лицензии истек
enum Connection
Тип авторизации.
Значение
Описание
fromServiceToken
Авторизация через токен:
host: String
token: String
fromCredentials
Авторизация через логин и пароль:
host: String
login: String
password: String
struct UploadMediaSettings
Настройки повторной отправки медиафайлов.
attemptsCount
Int
Количество попыток загрузки медиафайла
attemptsTimeout
Int
Интервал времени между попытками
enum SizeReductionStrategy
Определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа. По умолчанию отправляется сжатое видео.
Case
Description
uploadOriginal
Исходное видео
uploadCompressed
Сжатое видео
uploadBestShot
Полученный из видео лучший кадр
uploadNothing
Ничего (в этом случае на сервер не отправляется ничего, папка не создается)
Last updated