Перейти к основному содержимому

API захвата

Методы запуска сессии
МетодОписание
prepareSelfieCamera(_:config:)Подготавливает камеру для селфи
prepareSelfieCamera(_:config:prepareInfo:)Подготавливает камеру для селфи с метаданными PrepareInfo
prepareDocumentCamera(_:config:)Подготавливает камеру для документов
open(_:)Открывает подготовленную камеру для селфи
openDocument(_:delegate:)Открывает подготовленную камеру для документов с DocumentEnums
Параметры захвата

PrepareInfo — метаданные для идентификации пользовательской сессии.

ПолеТипОбязательноеОписание
externalUserIdStringдаИдентификатор пользователя в вашей системе. Перед передачей хешируется с помощью SHA-256.
useCaseStringнетИдентификатор контекста или текущего процесса. Передаётся в открытом виде.

DocumentEnums — см. Перечисления.

Типы результатов и поля

SelfieResult — объект, возвращаемый при успешном захвате селфи.

ПолеТипОписание
base64StringЗахваченное изображение в формате Base64
encryptedStringJWT для отправки на серверную часть

DocumentResult — объект, возвращаемый при успешном захвате документа. Содержит те же поля, что и SelfieResult.