В build.gradle проекта добавьте строки:

allprojects {
  repositories {
    maven { url "https://ozforensics.jfrog.io/artifactory/main" }
  }
}

В build.gradle модуля добавьте строки (VERSION – версия, которую вы планируете добавить. Список версий можно найти в Журнале изменений):

для анализов на сервере

dependencies {
  implementation 'com.ozforensics.liveness:sdk:VERSION'
}

для анализов и на сервере, и на устройстве

Обратите внимание: размер выходного файла будет больше.

dependencies {
implementation 'com.ozforensics.liveness:full:VERSION'
}

Вне зависимости от выбранного режима, добавьте еще:

android {
  compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
  }
}

Чтобы начать пользоваться нашим SDK, нужно выполнить следующие шаги.

1. Добавьте SDK в проект, как описано здесь.

2. Получите лицензию на SDK – сгенерируйте тестовую самостоятельно на нашем сайте или запросите «боевую» по электронной почте. Для лицензии потребуется application id. Добавьте лицензию в проект, как описано здесь.

3. Подключите SDK к API. Это необязательный шаг, он выполняется, только если вам нужно обрабатывать какие-либо данные на сервере. Если вы используете режим анализа на устройстве, никакие данные никуда не передаются, и подключение к API не нужно.

4. Для съемки видео используйте методы, описанные здесь – вы получите медиафайлы, которые потом можно будет отправить на анализ.

5. Запустите нужные вам проверки для полученных на предыдущем шаге медиафайлов. Здесь описано, как выполнять проверки.

6. Если вы хотите настроить внешний вид SDK, здесь написано, как это делается.

Ресурсы

Рекомендуемая версия Android: 5+ (чем новее смартфон, тем быстрее выполняются анализы).

Рекомендуемые версии компонентов:

Мы не поддерживаем эмуляторы.

Доступные языки: EN, RU, ES, HY, KK, KY, TR.

Исходные коды примеров приложений с использованием Oz Liveness SDK расположены в репозитории GitLab:

Список методов и полей SDK:

Актуальную сборку демо-приложения Вы можете загрузить по ссылке.

Сгенерируйте тестовую лицензию самостоятельно здесь (внимание, страница на английском языке) или свяжитесь с нами по email для выпуска продуктивной лицензии. Для подготовки лицензии потребуется applicationId (bundle id).

Для добавления файла лицензии в SDK вызовите метод OzLivenessSDK.init с одним из параметров LicenseSources:

• LicenseSource.LicenseAssetId должен содержать путь к файлу forensics.license, расположенному в проекте в папке res/raw.

• LicenseSource.LicenseFilePath должен содержать пусть к файлу на устройстве (вне проекта).

OzLivenessSDK.init(context,
    listOf(
        LicenseSource.LicenseAssetId(R.raw.your_license_name),
        LicenseSource.LicenseFilePath("абсолютный путь к файлу лицензии")
    ),
    object : StatusListener<LicensePayload> {
        override fun onSuccess(result: LicensePayload) { /*проверка информации о лицензии*/ }
        override fun onError(error: OzException) { /*обработка исключения */ }
    }
  )

OzLivenessSDK.INSTANCE.getConfig().setBaseURL(BASE_URL);
OzLivenessSDK.INSTANCE.init(context,
    Arrays.asList(
        new LicenseSource.LicenseAssetId(R.raw.forensics),
        new LicenseSource.LicenseFilePath("aбсолютный путь к файлу лицензии")
    ),
    new StatusListener<LicensePayload>() {
        @Override public void onStatusChanged(@Nullable String s) {}
        @Override public void onSuccess(LicensePayload licensePayload) { /*проверка информации о лицензии*/ }
        @Override public void onError(@NonNull OzException e) { /*обработка исключения */ }
    }
);

Если при обработке лицензии возникнут ошибки, вы получите сообщение с описанием этих ошибок. Если ошибок нет, система выведет данные о лицензии. Вы также можете запросить эти данные с помощью метода getLicensePayload.

Возможные ошибки лицензии

Мастер-лицензия – это оффлайн-лицензия, с которой можно использовать мобильные SDK без ограничений по bundle_id, в отличие от обычных лицензий. Для получения мастер-лицензии нужно создать пару ключей, как описано ниже. Отправьте нам публичный ключ по электронной почте, и вскоре после этого мы отправим вам мастер-лицензию. Вашему приложению нужно будет подписать свой bundle_id приватным ключом. Мобильные SDK проверяют подпись с помощью публичного ключа из мастер-лицензии. Действие таких лицензий ограничено по времени.

Генерация ключей

В этом разделе описано, как создавать приватный и публичный ключи.

Создание приватного ключа

Чтобы создать приватный ключ, последовательно запустите следующие команды:

openssl genpkey -algorithm RSA -outform DER -out privateKey.der -pkeyopt rsa_keygen_bits:2048
# for MacOS
base64 -i privateKey.der -o privateKey.txt
# for Linux 
base64 -w 0 privateKey.der > privateKey.txt

Вы получите два файла:

• privateKey.der – приватный ключ .der;

• privateKey.txt – privateKey.der в кодировке base64. Содержимое этого файла используется в качестве подписи bundle_id хостового приложения.

Спецификация команд OpenSSL: https://www.openssl.org/docs/man1.1.1/man1/openssl-pkcs8.html

Создание публичного ключа

Чтобы создать публичный ключ, запустите команду:

openssl rsa -pubout -in privateKey.der -out publicKey.pub

Вы получите публичный ключ publicKey.pub. Отправьте его нам по электронной почте. В ответ мы пришлем вам лицензию.

Интеграция SDK

Инициализация SDK:

fun init(
    context: Context,
    licenseSources: List<LicenseSource>,
    masterLicenseSignature: String,
    statusListener: StatusListener<LicensePayload>? = null,
 )

Перед инициализацией SDK создайте закодированную base64 подпись для bundle_id хостового приложения с помощью приватного ключа.

Пример создания подписи:

private fun getMasterSignature(): String {
    Security.insertProviderAt(org.spongycastle.jce.provider.BouncyCastleProvider(), 1)

    val privateKeyBase64String = "содержимое файла privateKey.txt"

    val sig = Signature.getInstance("SHA512WithRSA")
    val keySpec = PKCS8EncodedKeySpec(Base64.decode(privateKeyBase64String, Base64.DEFAULT))
    val keyFactory = KeyFactory.getInstance("RSA")
    sig.initSign(keyFactory.generatePrivate(keySpec))
    sig.update(packageName.toByteArray(Charsets.UTF_8))
    return Base64.encodeToString(sig.sign(), Base64.DEFAULT).replace("\n", "")
 }

KohJ1rsUgLMzZHpHGAZDK2efHPnMj9tw9VIedBLvyZt0B2JH3SWfJLJ8X6JNz3bR2sce6PR2wdEIFln0r1pUnD+6WBCgexKIHAv7esiRVQZoZOEANDBwDvJVv73H/0qL2LGlhxKzbBg5CxGPClTBQdLo1P+7HsTXHHG/Hf6m3rdu1OUeGXVPoaS2NzE8kiRH6gb8Nhr7PBLTUeMKTeLoiX13hvwjOqhV1ANhgS97T4hC2+ZilZt4RektgRY/+fGmWnOqErNeYuz/WSInfaJS0YEWhJW3gXKPjdCzNGIBIqbxaFSjU46wu/alh2+tBRFnrYFl1dRQVcTlW0VwwZHcug==

Передайте подпись как параметр masterLicenseSignature во время инициализации SDK.

Если подпись невалидна, инициализация продолжится по стандартной схеме: проверка включенных в лицензию bundle_id.

Oz Mobile SDK – Software Developer’s Kit системы Oz Forensics, обеспечивающий удобную интеграцию с мобильными приложениями для регистрации и биометрической идентификации клиентов.

Обычный режим выполнения проверок на iOS / Android SDK подразумевает проведение проверок на сервере: данные для анализов Liveness и Biometry с телефона отсылаются на сервер, где и происходит сам анализ, затем сервер отправляет результаты анализов обратно на телефон. Этот процесс показан на схеме ниже:

Однако анализы могут выполняться непосредственно на устройстве без подключения к серверу или даже интернету в целом:

Анализы на устройстве выполняются быстрее, а также это более безопасный способ проверки, так как никакая информация никуда не отправляется, персональные данные остаются на устройстве. В этом случае не нужны ни сервер, ни подключение к API.

Когда может понадобиться режим анализа на устройстве?

• Вы не планируете собирать и обрабатывать персональные данные;

• Вам необходима быстрая и не зависящая от скорости сети верификация – например, в удаленных регионах, внутри зданий, под землей и так далее;

• У вас ограниченный бюджет и вы хотели бы сэкономить на оборудовании.

Запуск анализов на устройстве

Для запуска анализов на устройстве установите соответствующий режим (mode) анализа для Android или iOS SDK.

Android:

iOS:

Если вы при обновлении с прежних версий (до 6.4.2 включительно) хотите сохранить привычный для клиентов дизайн, сбросьте настройки интерфейса экрана съемки до значений по умолчанию и примените следующие параметры (приведены только те параметры, которые нужно изменить):

Если наш SDK используется только для съемки, пропустите этот шаг.

Чтобы выполнить проверку, нужно загрузить в систему медиафайлы, а затем запустить для них анализы.

Пример работы:

Для удаления медиафайлов после выполнения всех проверок используйте метод clearActionVideos.

Добавление метаданных

Для добавления метаданных используйте метод addFolderMeta.

Извлечение лучшего кадра

В структуре Analysis можно передать дополнительные параметры, например, для извлечения на сервере лучшего кадра.

Использование медиафайла, снятого не нашим SDK

Добавление медиафайлов в определенную папку

Для добавления медиафайлов в определенную папку используйте метод setFolderId:

Для авторизации в Oz API используйте адрес API и , как показано ниже.

Второй вариант: логин и пароль.

Мы рекомендуем использовать метод аутентификации по токену доступа, как более безопасный.

По умолчанию логи сохраняются вместе с данными по анализам. Если вы планируете хранить логи отдельно от этих данных, настройте отдельное подключение для :

Очистка авторизации:

Проверка наличия сохраненного access-токена Oz API:

LogOut:

Для старта записи видео используется метод startActivityForResult:

actions – перечень при записи видео.

Для представления Fragment код приведен ниже. LivenessFragment – для экрана Liveness.

Для получения результатов записи видео используется метод onActivityResult:

Если пользователь прервет запись видео (закроет экран), resultCode примет значение Activity.RESULT_CANCELED.

Пример кода для обработки:

Обратите внимание: описанная ниже функциональность работает, начиная с версии 8.1.0.

Чтобы добавить или обновить языковой пакет для Oz Android SDK, сделайте следующие шаги:

1. Перейдите в папку для нужной локали или создайте такую папку. Детально процесс описан .

2. Создайте файл и назовите его strings.xml.

3. Скопируйте строки из приложенного файла в только что созданный.

4. Переопределите в переводах строки, которые вам нужны.

Список переводов для Android:

Ключи вида action_*_go относятся к соответствующим жестам. Остальные – к подсказкам для всех жестов, информационным сообщениям или ошибкам.

Когда вместе с новыми версиями появляются новые ключи, если вы не переопределите соответствующие строки в вашем файле, текст для новых ключей будет показываться на английском языке.

Настройки Oz Mobile SDK

Применять настройки рекомендуется при старте приложения.

Настройка интерфейса Oz Mobile SDK

Чтобы настроить интерфейс Oz Liveness, воспользуйтесь UICustomization. Полный список полей находится .

По умолчанию SDK использует локаль устройства. Чтобы сменить локаль, используйте код ниже:

8.12.4 – 01.10.2024

• Обновления безопасности.

8.12.2 – 10.09.2024

• Обновления безопасности.

8.12.0 – 29.08.2024

• Обновления безопасности и журналирования.

8.11.0 – 19.08.2024

• Исправили ошибку RuntimeException, появлявшуюся в режиме серверного Liveness на некоторых моделях телефонов.

• Обновления безопасности.

8.10.0 – 26.07.2024

• Обновления безопасности.

• Исправили ошибки.

8.9.0 – 18.07.2024

• Подняли версию плагина Android Gradle до 8.0.0.

• Улучшили работу SDK.

8.8.3 – 11.07.2024

• Улучшили работу SDK.

8.8.2 – 21.06.2024

• Обновления безопасности.

8.8.1 – 12.06.2024

• Обновления безопасности.

8.8.0 – 04.06.2024

• Обновления безопасности.

8.7.3 – 03.06.2024

• Обновления безопасности.

8.7.0 – 06.05.2024

• При попытке передать пустую строку в качестве аргумента для метода setFolderId теперь показывается информативная ошибка.

• Исправили ошибку с бесконечно крутящимся спиннером, который появлялся при переключении пользователя на другое приложение во время прохождения проверки Liveness.

• Исправили несколько ошибок, появлявшихся только на определенных моделях смартфонов.

8.6.0 – 05.04.2024

• Улучшили модель Liveness для проверки на устройстве.

• Обновления безопасности.

8.5.0 – 27.02.2024

• Длительность жеста Селфи теперь можно менять (размер видеофайла также изменится).

• Вы можете заменить логотип Oz своим, если ваша лицензия это предусматривает.

• Убрали паузу после жеста Сканирование.

• Если размер записанного видеофайла больше 10 Мбайт, видео будет сжато.

• Обновления безопасности и журналирования.

8.4.4 – 06.02.2024

• Изменили алгоритм валидации для мастер-лицензии.

8.4.3 – 29.01.2024

• Снизили требования к compileSdkVersion с 34 до 33.

8.4.2 – 15.01.2024

• Обновления безопасности.

8.4.0 – 04.01.2024

• Обновили модель Liveness для проверки на устройстве.

• Исправили ошибки.

8.3.3 – 11.12.2023

• Улучшили работу механизмов лицензирования.

8.3.2 – 30.11.2023

• Улучшили работу SDK.

8.3.1 – 24.11.2023

• Исправили ошибки.

8.3.0 – 17.11.2023

• Добавили возможность использования мастер-лицензии, которая работает с любым bundle_id.

• Исправили ошибку со сжатием видео при гибридном анализе, которая возникала на некоторых моделях телефонов.

8.2.1 – 01.11.2023

• Исправили ошибки.

8.2.0 – 23.10.2023

• Добавили в структуру Analysis поле sizeReductionStrategy. Оно определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа.

• Настройка toFrameGradientColor для кастомизации подсказки hintAnimationCustomization больше не используется. Вместо нее используйте hintGradientColor.

• Сообщения для получаемых из API ошибок теперь детализированы.

8.1.1 – 02.10.2023

• Если несколько анализов назначаются на папку одновременно, система отправляет их группой. Таким образом, выбирается “худший” результат среди всех анализов, а не последний назначенный. Прочитать про отправку анализов группой можно здесь.

• В анализе Liveness для количественного результата теперь берется максимальный из вычисленных. Прочитать о результате можно здесь.

8.1.0 – 07.09.2023

• Обновили модель Liveness для проверки на устройстве.

• Добавили португальский язык (бразильский вариант).

• Вы теперь можете добавить язык или изменить текущие переводы самостоятельно. Как это сделать, описано здесь.

• Если медиафайл по каким-то причинам не загрузился, система повторяет загрузку.

• Добавили новый метод для получения идентификатора телеметрии (логирования): getEventSessionId.

• Методы auth и login больше не используются. Вместо них, пожалуйста, используйте метод setApiConnection.

• OzConfig.baseURL и OzConfig.permanentAccessToken больше не используются.

• Если пользователь закрывает экран во время съемки видео, соответствующая ошибка обрабатывается SDK.

• Исправили ошибки и улучшили работу SDK.

8.0.3 – 24.08.2023

• Исправили ошибки.

8.0.2 – 13.07.2023

• При установке baseURL = null SDK теперь работает корректно.

8.0.1 – 28.06.2023

• Версии зависимостей SDK приведены в соответствие с версией Kotlin.

8.0.0 – 19.06.2023

• Добавлен новый тип анализа – гибридный (сейчас работает только для Liveness). В случае спорных результатов анализа на устройстве проводится дополнительная проверка на сервере.

• Требования к версии Kotlin понижены до 1.7.21.

• Обновлены модели для анализов на устройстве.

• На некоторых моделях телефонов исправлена ошибка fatal device.

• Текст подсказки теперь может выходить за границы рамки для лица по горизонтали (для основной камеры).

• Фото, снятые во время однокадрового анализа, теперь передаются на сервер в оригинальном размере.

• Удален класс OzAnalysisResult. В параметре onSuccess метода AnalysisRequest.run вместо списка OzAnalysisResult теперь передается структура RequestResult.

• Все исключения перенесены в папку com.ozforensics.liveness.sdk.core.exceptions (детальная информация ниже).

• Связанные с AnalysisRequest классы перенесены в com.ozforensics.liveness.sdk.analysis (детальная информация ниже).

• Прекращена поддержка методов:

7.3.1 – 07.06.2023

• Обновили экран настроек.

• Добавили настройки для фона подсказки.

• Добавили новые формы рамки (круг, квадрат).

• Добавили виджет для защиты от мошенничества и набор настроек к нему. С помощью этого виджета вы можете уведомлять пользователей, что ведется съемка видео для, например, отправления заявки на кредит. Таким образом вы сможете защитить пользователей, если мошенники попытаются убедить их подтвердить такой запрос.

• Метод OzLivenessSDK::init при передаче параметра StatusListener теперь работает корректно.

• Изменили анимацию жеста "Сканирование".

7.2.0 – 04.05.2023

• Улучшили работу алгоритмов SDK.

7.1.4 – 30.03.2023

• Обновили модель для выполнения анализов на устройстве.

• Обновили анимацию для солнечных очков / маски.

• Немного уменьшили размеры овала для Liveness.

7.1.3 – 03.03.2023

• Исправили ошибку, появлявшуюся при выполнении серверных анализов после использования для авторизации permanentAccessToken.

7.1.2 – 22.02.2023

• Добавили возможность анимации подсказки.

• Полосу статуса и системные кнопки теперь можно скрывать (работает с версии 7.0.0).

• В метод OzLivenessSDK.init теперь нужно первым параметром передавать context.

• OzAnalysisResult теперь корректно показывает оценки по серверным анализам.

• Исправлены ошибки инициализации и некорректного отображения настроек кастомизации, а также ошибки некорректной авторизации на версиях Android < 7.1.1.

7.1.1 – 16.01.2023

• Исправили ошибку с вылетами на версиях Android <6.

• Поправили расположение овала для некоторых моделей телефонов.

• Улучшили работу SDK.

7.1.0 – 16.12.2022

• Обновили систему безопасности.

• Добавили некоторые внутренние улучшения.

• Метод addMedia больше не работает. Для загрузки медиафайлов воспользуйтесь методом uploadMedia.

7.0.0 – 23.11.2022

• Из соображений безопасности мы теперь поставляем два типа библиотек: sdk только для серверного анализа и full для серверного анализа и анализа на устройстве.

• Заменили OzCustomization на UICustomization.

• Значительно расширили список настроек кастомизации SDK и обновили дизайн. Если вы хотите вернуть дизайн из прошлых версий, соответствующие настройки описаны здесь.

• Добавили испанский язык.

6.4.2

• Исправили ошибку с зависаниями на некоторых моделях телефонов.

• SDK теперь снимает видео в разрешении 720p (с 6.4.2.3).

6.4.1

• Наименование режимов анализа приведено в соответствие с iOS: SERVER_BASED и ON_DEVICE.

• Исправили ошибку с отображением настроек локализации.

6.4.0

• Теперь в качестве Liveness-экрана можно использовать Fragment.

• Добавили новое поле params в структуру Analysis – с его помощью можно задавать дополнительные параметры, например, для извлечения на сервере лучшего кадра. Алгоритм "лучший кадр" выбирает из видеозаписи наиболее качественный и удачный кадр с лицом.

6.3.7

• Жесты отдаления и приближения больше не поддерживаются.

6.3.6

• Обновили биометрическую модель.

6.3.5

• Добавили новую упрощенную структуру AnalysisRequest – теперь конструировать запросы на анализы стало проще и удобнее.

6.3.4

• Добавили модуль для выполнения анализов локально на устройстве. Подключите модуль:

    implementation 'com.ozforensics.liveness:on-device:6.3.4'

Для запуска анализов biometry и liveness используйте соответствующие методы класса OzLivenessSDK: runOnDeviceBiometryAnalysis и runOnDeviceLivenessAnalysis.

val mediaList: List<OzAbstractMedia> = ...
val biometryAnalysisResult: OzAnalysisResult = OzLivenessSDK.runOnDeviceBiometryAnalysis(mediaList)
val livenessAnalysisResult: OzAnalysisResult = OzLivenessSDK.runOnDeviceLivenessAnalysis(mediaList)

6.3.3

• Liveness теперь работает плавнее.

• На устройствах Xiaomi больше не зависает камера.

• Оптимизировали преобразования изображений с камеры.

6.3.1

• В OzLivenessSDK.uploadMedia добавили параметр metadata и методы OzLivenessSDK.uploadMediaAndAnalyze для передачи metadata в папки.

6.2.8

• Добавили функции для инициализации SDK с лицензиями LicenseSources: LicenseSource.LicenseAssetId иLicenseSource.LicenseFilePath. Для инициализации используйте метод OzLivenessSDK.init.

• Добавили возможность получения информации о лицензии после инициализации val licensePayload = OzLivenessSDK.getLicensePayload().

6.2.4

• Добавили киргизский язык.

6.2.0

• Добавили функции для локальных анализов.

• Добавили конфигурацию рамки вокруг лица.

• Номер версии на экране Liveness теперь отображается корректно.

6.1.0

• Добавили поддержку основной камеры.

6.0.0

• Добавили жест OneShot.

• Добавили состояний в OzAnalysisResult.Resolution.

• Добавили метод uploadMediaAndAnalyze – он загружает список изображений/видео на сервер и сразу отправляет их на анализ.

• OzMedia превратили в OzAbstractMedia и добавили подклассы изображений и видео.

• Исправили ошибки камеры на некоторых устройствах.

5.1.0

• Токен доступа теперь обновляется автоматически.

• Переименовали accessToken в permanentAccessToken.

• Добавили правила R8.

• Упростили процесс конфигурации. Свойства config теперь можно менять.

5.0.2

• Исправили овальную рамку.

• Убрали неиспользуемые параметры params из AnalyseRequest.

• Убрали лимит по умолчанию на количество попыток.

5.0.0

• Убрали свойства конфигурации - baseURL, accessToken и так далее. Заменили их на свойство config, которое нужно инициализировать с помощью OzConfig.Builder.

• Добавили поддержку лицензий. Их нужно устанавливать как raw ресурсы и передавать в OzConfig через setLicenseResourceId.

• Убрали методы, которым нужен был контекст. Заменили аналогами.

• Анализ изображений теперь работает лучше.

• Убрали ненужные зависимости.

• Поправили ошибки журналирования.

Чтобы начать пользоваться нашим SDK, нужно выполнить следующие шаги.

1. Добавьте SDK в проект, как описано .

2. Получите лицензию на SDK – сгенерируйте тестовую самостоятельно на нашем или запросите «боевую» по . Для лицензии потребуется bundle id. Добавьте лицензию в проект, как описано .

3. SDK к API. Это необязательный шаг, он выполняется, только если вам нужно обрабатывать какие-либо данные на сервере. Если вы используете , никакие данные никуда не передаются, и подключение к API не нужно.

4. Создайте контроллер для съемки, как описано – вы получите медиафайлы, которые потом можно будет отправить на анализ.

5. Запустите нужные вам проверки для полученных на предыдущем шаге медиафайлов. описано, как выполнять проверки.

6. Если вы хотите настроить внешний вид SDK, написано, как это делается.

Ресурсы

Минимальная версия iOS: 11.

Минимальная версия Xcode: 15 (для версий 8.10.0 и новее).

Доступные языки: EN, RU, ES, HY, KK, KY, TR.

Исходный код примера приложения с использованием Oz Liveness SDK расположен в репозитории GitLab:

Список методов и полей SDK:

OzLivenessSDK

Синглтон (шаблон-одиночка) для Oz SDK.

clearActionVideos

Удаляет все видеоролики.

Параметры

-

Возвращает

-

createStartIntent

Создает намерение (intent) для запуска Liveness.

Возвращает

-

getErrorFromIntent

Запрашивает ошибку из намерения (intent) OnActivityResult (при наличии).

Возвращает

Текст ошибки.

getLicensePayload

Запрашивает информацию о лицензии SDK.

Параметры

-

Возвращает

getResultFromIntent

Запрашивает медиафайлы из намерения (intent) OnActivityResult.

Возвращает

init

Инициализирует SDK, используя данные лицензии.

Возвращает

-

log

Включает журналирование, запуская соответствующие механизмы Oz Liveness SDK.

Возвращает

-

setApiConnection

Подключение к API.

setEventsConnection

Подключение к серверу телеметрии.

logout

Удаляет сохраненный токен.

Параметры

-

Возвращает

-

getEventSessionId

Запрашивает идентификатор сессии телеметрии.

Параметры

-

Возвращает

Идентификатор сессии телеметрии (String).

version

Запрашивает версию SDK.

Параметры

-

Возвращает

Номер версии SDK (String).

generateSignedPayload

Создает payload с подписями медиафайлов.

Возвращает

payload для загрузки вместе с медиафайлами, для которых он был сгенерирован.

AnalysisRequest

Класс для выполнения проверок.

run

Запускает анализы.

class Builder

Конструктор для AnalysisRequest.

build

Создает AnalysisRequest.

Параметры

-

Возвращает

Экземпляр класса AnalysisRequest.

addAnalysis

Добавляет в запрос анализ.

Возвращает

Ошибку в случае ее появления.

addAnalyses

Добавляет в запрос список анализов (можно назначить несколько анализов для одной папки).

Возвращает

Ошибку в случае ее появления.

addFolderMeta

Добавляет метаданные в создаваемую папку (только для анализа на сервере).

Возвращает

Ошибку в случае ее появления.

uploadMedia

Добавляет один или несколько медиафайлов в папку для последующего выполнения проверок.

Возвращает

Ошибку в случае ее появления.

setFolderId

Устанавливает идентификатор для ранее созданной папки. Эта папка должна существовать на сервере, иначе создастся новая.

Возвращает

Ошибку в случае ее появления.

OzConfig

Конфигурация OzLivenessSDK (используйте OzLivenessSDK.config).

setSelfieLength

Устанавливает длительность жеста Селфи (в миллисекундах).

Возвращает

Ошибку в случае ее появления.

allowDebugVisualization

Возможность отображать дополнительную отладочную информацию при нажатии на текст версии.

attemptSettings

Количество попыток выполнить анализы, после которого SDK выдаст ошибку.

baseURL

URL сервера API для работы с телеметрией.

faceAlignmentTimeout

Время, в течение которого нужно поместить лицо в рамку и выполнить жест (в миллисекундах).

uploadMediaSettings

Настройки повторной отправки медиафайлов.

livenessErrorCallback

Интерфейс для обработки ошибок.

localizationCode

Локализация текста.

logging

Настройки журналирования.

useMainCamera

Включает использование основной (задней) камеры для съемки вместо фронтальной.

UICustomization

Настройки кастомизации OzLivenessSDK (используйте OzLivenessSDK.config.customization).

hideStatusBar

Скрывает системные части экрана: полосу статуса и кнопки. По умолчанию имеет значение True.

toolbarCustomization

Настройки кастомизации верхней панели.

centerHintCustomization

Настройки кастомизации текста подсказки, ориентируясь на который, пользователь снимает фото или видео.

hintAnimation

Настройки кастомизации для анимации подсказки.

faceFrameCustomization

Настройки кастомизации рамки вокруг лица.

backgroundCustomization

Настройки кастомизации фона за рамкой.

versionTextCustomization

Настройки кастомизации текста версии SDK.

antiscamCustomization

Настройки кастомизации для защиты от мошенничества (сообщение о том, что идет запись).

logoCustomization

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

Переменные и объекты

enum OzAction

Действие, представленное на видео.

class LicensePayload

Содержит расширенную информацию о параметрах лицензии.

sealed class OzAbstractMedia

Класс для снятого фото или видео, может быть:

OzDocumentPhoto

Фото документа.

OzShotSet

Набор кадров (shot set) в архиве.

OzVideo

Видео с проверкой Liveness.

enum OzMediaTag

Тег в соответствии с жестом на видео.

sealed class LicenseSource

Класс для хранения лицензии, может быть:

LicenseAssetId

Содержит идентификатор лицензии.

LicenseFilePath

Содержит путь к лицензии.

class AnalysisStatus

Класс для статуса анализа, может быть:

RunningAnalysis

Статус означает, что анализы запущены.

UploadingMedia

Статус означает, что в настоящее время загружаются медиафайлы.

enum Type

Тип анализа.

enum Mode

Режим анализа.

class Analysis

Содержит информацию о том, какие анализы и к каким медиафайлам применять.

enum Resolution

Сводный статус по выполненным анализам.

class OzAttemptsSettings

Количество попыток выполнения анализов, после которого SDK выдаст ошибку.

enum OzLocalizationCode

class OzLogging

Настройки журналирования.

sealed class Color

Настройки цвета, в зависимости от принимаемого значения могут быть:

ColorRes

ColorHex

ColorInt

enum GeometryType

Форма рамки.

class AnalysisError

Класс для описания ошибок.

class SourceMedia

Описывает отправленный на анализ медиафайл.

class ResultMedia

Описывает результат анализа для одного медиафайла.

class RequestResult

Сводный результат анализа для всех медиафайлов.

class AnalysisResult

Описывает результаты анализов для всех медиафайлов в папке.

class OzConnection

Определяет метод авторизации.

OzConnection.fromServiceToken

Авторизация по токену.

OzConnection.fromCredentials

Авторизация по логину и паролю.

class OzUploadMediaSettings

Настройки повторной отправки медиафайлов.

enum SizeReductionStrategy

Определяет размер файла, отправляемого на сервер после успешного завершения проверки на устройстве в составе гибридного анализа. По умолчанию отправляется сжатое видео.

Возможные ошибки

CocoaPods

Для добавления OZLivenessSDK в ваше приложение через менеджер зависимостей CocoaPods и интеграции OZLivenessSDK в проект Xcode добавьте в Podfile:

VERSION (опционально, по умолчанию устанавливается последняя версия) – версия, которую можно найти в .

Начиная с версии 8.1.0, можно использовать упрощенный код:

По умолчанию устанавливается полная версия SDK (с режимами анализа на сервере и на устройстве). Если нужен только серверный анализ, код будет выглядеть так:

Для версий 8.1.0 и выше:

SPM

Установка через SPM возможна для SDK версий 8.7.0 и новее.

Ручная установка

Вы также можете добавить файлы SDK в проект вручную.

• OZLivenessSDK.xcframework,

• OZLivenessSDKResources.bundle,

• OZLivenessSDKOnDeviceResources.bundle (если вы не используете анализы на устройстве, этот файл можно не скачивать).

3. Убедитесь, что:

• оба файла xcframework отображаются в Target-Build Phases -> Link Binary With Libraries и Target-General -> Frameworks, Libraries, and Embedded Context;

• файл(ы) bundle отображаются в Target-Build Phases -> Copy Bundle Resources.

Мастер-лицензия – это оффлайн-лицензия, с которой можно использовать мобильные SDK без ограничений по bundle_id, в отличие от обычных лицензий. Для получения мастер-лицензии нужно создать пару ключей, как описано ниже. Отправьте нам публичный ключ по электронной почте, и вскоре после этого мы отправим вам мастер-лицензию. Вашему приложению нужно будет подписать свой bundle_id приватным ключом. Мобильные SDK проверяют подпись с помощью публичного ключа из мастер-лицензии. Действие таких лицензий ограничено по времени.

Генерация ключей

В этом разделе описано, как создавать приватный и публичный ключи.

Создание приватного ключа

Чтобы создать приватный ключ, последовательно запустите следующие команды:

Вы получите два файла:

• privateKey.der – приватный ключ .der;

• privateKey.txt – privateKey.der в кодировке base64. Содержимое этого файла используется в качестве подписи bundle_id хостового приложения.

Спецификация команд OpenSSL:

Создание публичного ключа

Чтобы создать публичный ключ, последовательно запустите следующие команды:

Вы получите публичный ключ publicKey.pub. Отправьте его нам по электронной почте. В ответ мы пришлем вам лицензию.

Интеграция SDK

Инициализация SDK:

Установка лицензии:

Перед инициализацией SDK создайте закодированную base64 подпись для bundle_id хостового приложения с помощью приватного ключа.

Пример создания подписи:

Передайте подпись как параметр masterLicenseSignature во время инициализации SDK или установки лицензии.

Если подпись невалидна, инициализация продолжится по стандартной схеме: проверка включенных в лицензию bundle_id.

Для работы SDK требуется лицензия. Сгенерируйте тестовую лицензию самостоятельно (внимание, страница на английском языке) или свяжитесь с нами по для выпуска продуктивной лицензии. Для подготовки лицензии потребуется bundle id. Есть два способа добавить лицензию в проект:

1. Переименуйте файл в forensics.license и поместите его в проект. Прописывать путь в этом случае не нужно.

2. Обновление лицензии для уже работающего приложения или в том случае, если вы хотите держать лицензию вне проекта:

или

LicenseSource – источник лицензии, LicenseData – информация о лицензии. В этот метод встроена проверка наличия активной лицензии, если такая лицензия есть – будет использоваться она, а не та, путь к которой вы указали. Для принудительной замены лицензии используйте метод setLicense.

Если при обработке лицензии возникнут ошибки, вы получите сообщение с описанием этих ошибок. Если ошибок нет, система выведет данные о лицензии. Вы также можете запросить эти данные с помощью OZSDK.licenseData.

Возможные ошибки лицензии

Для авторизации в Oz API используйте адрес API и , как показано ниже.

Второй вариант: логин и пароль.

Мы рекомендуем использовать метод аутентификации по токену доступа, как более безопасный.

По умолчанию логи сохраняются вместе с данными по анализам. Если вы планируете хранить логи отдельно от этих данных, настройте отдельное подключение для :

Обратите внимание: описанная ниже функциональность работает, начиная с версии 8.1.0.

Чтобы добавить или обновить языковой пакет для Oz iOS SDK, используйте метод set(languageBundle: Bundle). Он информирует SDK, что вы планируете использовать отличный от стандартного бандл. В OzLocalizationCode используйте кастомный язык (опционально).

• Если вы не укажете кастомные язык и бандл, SDK будет использовать имеющиеся переводы.

• Если бандл указан, а язык нет, приоритетным считается перевод для ключа из файла локализации кастомного бандла. Если такой ключ там не найден, перевод берется из стандартного бандла.

• Если указаны кастомные и бандл, и язык, все переводы берутся из файла локализации кастомного бандла.

Список переводов для iOS:

Ключи вида Action.*.Task относятся к соответствующим жестам. Остальные – к подсказкам для всех жестов, информационным сообщениям или ошибкам.

При появлении новых ключей, если переводов для них в кастомном бандле нет, будет показываться текст на языке по умолчанию (английском).

Создайте контроллер для съемки видео:

action– перечень при записи видео.

По окончании съемки вызывается метод onOZLivenessResult(results:[OZMedia]):

Метод возвращает результаты съемки в виде массива объектов[], которые используются на следующем шаге для выполнения проверок.

Если пользователь прервет запись видео (закроет экран), появится ошибка failedBecauseUserCancelled.

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

Чтобы настроить интерфейс Oz Liveness, воспользуйтесь OZCustomization. Полный список полей находится .

Если наш SDK используется только для съемки, пропустите этот шаг.

Чтобы выполнить проверку, нужно загрузить в систему медиафайлы, а затем запустить для них анализы.

Пример:

Для удаления медиафайлов после выполнения всех проверок используйте метод clearTempDirectory.

Добавление метаданных

Для добавления метаданных используйте метод AnalysisRequest.addFolderMeta.

Извлечение лучшего кадра

В структуре Analysis можно передать дополнительные параметры, например, для извлечения на сервере лучшего кадра.

Использование медиафайла, снятого не нашим SDK

Добавление медиафайлов в определенную папку

Для добавления медиафайлов в определенную папку используйте метод addFolderId:

Если вы при обновлении с прежних версий (до 6.4.2 включительно) хотите сохранить привычный для клиентов дизайн, сбросьте настройки интерфейса экрана съемки до значений по умолчанию и примените следующие параметры (приведены только те параметры, которые нужно изменить):