Métodos e propriedades do iOS SDK
OZSDK
Um singleton para Oz SDK.
Métodos
OZSDK
Inicializa OZSDK com os dados da licença. A closure é ou dados de licença ou LicenseError.
Retorna
-
setLicense
Força a instalação da licença.
setApiConnection
Define a conexão com Oz API.
Retorna
O token de acesso ou um erro.
setEventsConnection
Define a conexão com o servidor de telemetria.
Retorna
O token de acesso ou um erro.
isLoggedIn
Verifica se existe um token de acesso.
Parâmetros
-
Retorna
O resultado – o valor verdadeiro ou falso.
logout
Exclui o token de acesso salvo
Parâmetros
-
Retorna
-
createVerificationVCWithDelegate
Cria o controlador de verificação de Liveness.
cameraPosition (optional)
AVCaptureDevice.Position
front – câmera frontal (padrão),
back – câmera traseira
Retorna
UIViewController ou uma exceção.
createVerificationVC
Cria o controlador de verificação de Liveness.
FaceCaptureCompletion
alias de tipo usado da seguinte forma:
public typealias FaceCaptureCompletion = (_ results: [OZMedia]?, _ error: OZVerificationStatus?) -> Void
cameraPosition (optional)
AVCaptureDevice.Position
front – câmera frontal (padrão),
back – câmera traseira
Retorna
UIViewController ou uma exceção.
cleanTempDirectory
Exclui todos os vídeos.
Parâmetros
-
Retorna
-
getEventSessionId
Recupera o ID da sessão de telemetria.
Parâmetros
-
Retorna
O ID da sessão de telemetria (parâmetro String).
set
Define o bundle no qual buscar traduções.
languageBundle
Bundle
O bundle que contém traduções
Retorna
-
set
Define o nome da tabela de localização na qual buscar traduções.
localizableTableName
String
O nome da .strings tabela em Bundle.main contendo traduções da interface. Se especificada, o SDK usa essa tabela e recorre às suas strings internas para chaves ausentes
Retorna
-
setSelfieLength
Define a duração do Selfie gesto (em milissegundos).
selfieLength
Int
A duração do Selfie gesto (em milissegundos). Deve estar entre 500-5000 ms, a duração padrão é 700
generateSignedPayload
Gera a carga útil com assinaturas de mídia.
folderMeta
[String]
Metadados adicionais da pasta
Retorna
Carga útil a ser enviada junto com os arquivos de mídia usados para a geração.
setEnvironment
Define o ambiente do SDK.
Propriedades
localizationCode
Localidade do SDK (se não estiver definida, funciona automaticamente).
host
O host a ser chamado para análise de vídeo de Liveness.
host
String
Endereço do host
attemptSettings
O contêiner para a contagem de tentativas antes de o SDK retornar um erro.
singleCount
Int
Tentativas em uma única ação/gesto
commonCount
Int
Número total de tentativas em todas as ações/gestos se você usar uma sequência delas
faceAlignmentTimeout
Float
Tempo necessário para alinhar o rosto no enquadramento
version
A versão do SDK.
version
String
Número da versão
OZLivenessDelegate
Um delegate para OZSDK.
Métodos
onOZLivenessResult
Obtém os resultados da verificação de Liveness.
Retorna
-
onError
O método de processamento de erro.
Retorna
-
AnalysisRequest
Um protocolo para realizar verificações.
Métodos
AnalysisRequestBuilder
Cria a instância de AnalysisRequest.
folderId (optional)
String
O identificador a ser definido quando for necessário enviar mídia para uma pasta específica.
Retorna
A instância de AnalysisRequest.
addAnalysis
Adiciona uma análise à instância de AnalysisRequest.
Retorna
-
uploadMedia
Envia mídia para o servidor.
Retorna
-
addFolderId
Adiciona o ID da pasta para enviar mídia para uma pasta específica.
folderId
String
O identificador da pasta.
Retorna
-
addFolderMeta
Adiciona metadados a uma pasta.
meta
[String]
Uma matriz de metadados da seguinte forma:
["meta1": "data1"]
Retorna
-
run
Executa as análises.
statusHandler
Uma função de callback da seguinte forma:
statusHandler: @escaping ((_ status: RequestStatus) -> Void)
O manipulador executado quando o estado do cenário muda
errorHandler
Uma função de callback da seguinte forma:
errorHandler: @escaping ((_ error: Error) -> Void)
Manipulador de erro
completionHandler
Uma função de callback da seguinte forma:
completionHandler: @escaping (_ results : RequestResult) -> Void)
O manipulador executado quando o método run é concluído.
Retorna
O resultado da análise ou um erro.
useInstantMode
Gerencia a interação com Instant API. Defina como true para ativar o modo de API não persistente (useInstantMode(true)).
Personalização
Personalização para OzLivenessSDK (use OZSDK.customization).
toolbarCustomization
Um conjunto de parâmetros de personalização para a barra de ferramentas.
closeButtonIcon
UIImage
Uma imagem para o botão de fechar
closeButtonColor
UIColor
Botão de fechar tintColor
titleFont
UIFont
Fonte do texto do título da barra de ferramentas
titleColor
UIColor
Cor do texto do título da barra de ferramentas
backgroundColor
UIColor
Cor de fundo da barra de ferramentas
titleText
String
Texto na barra de ferramentas
centerHintCustomization
Um conjunto de parâmetros de personalização para a dica central que orienta o usuário durante o processo de tirar uma imagem de si mesmo.
textFont
UIFont
Fonte do texto da dica central
textColor
UIColor
Cor do texto da dica central
backgroundColor
UIColor
Fundo do texto da dica central
verticalPosition
Int
Posição vertical da dica central a partir do topo da tela (em %, 0-100)
hideTextBackground
Bool
Oculta o fundo do texto
backgroundCornerRadius
Int
Raio dos cantos da moldura de fundo da dica central
hintAnimationCustomization
Um conjunto de parâmetros de personalização para a animação da dica.
hideAnimation
Bool
Um alternador para a animação da dica, se True, a animação é ocultada
animationIconSize
CGfloat
O tamanho lateral do quadrado do ícone da animação
hintGradientColor
UIColor
A cor do gradiente próximo à moldura
faceFrameCustomization
Um conjunto de parâmetros de personalização para a moldura ao redor do rosto do usuário.
cornerRadius
CGFloat
Raio dos cantos do retângulo (em dp)
strokeFaceNotAlignedColor
UIColor
Cor da moldura quando o rosto não está alinhado corretamente
strokeFaceAlignedColor
UIColor
Cor da moldura quando o rosto está alinhado corretamente
strokeWidth
CGFloat
Largura do traço da moldura (em dp, 0-20)
strokePadding
CGFloat
Um espaçamento do traço até a área de alinhamento do rosto (em dp, 0-10)
backgroundCustomization
Um conjunto de parâmetros de personalização para o fundo fora da moldura.
backgroundColor
UIColor
Cor de fundo
versionCustomization
Um conjunto de parâmetros de personalização para o texto da versão do SDK.
textFont
UIFont
Fonte do texto da versão do SDK
textColor
UIColor
Cor do texto da versão do SDK
antiscamCustomization
Um conjunto de parâmetros de personalização para a mensagem de alerta que avisa o usuário de que suas ações estão sendo gravadas. Essa mensagem é posicionada acima do oval.
customizationEnableAntiscam
Bool
Adiciona a mensagem antiscam
customizationAntiscamTextMessage
String
Texto da mensagem antiscam
customizationAntiscamTextFont
UIFont
Fonte do texto da mensagem antiscam
customizationAntiscamTextColor
UIColor
Cor do texto da mensagem antiscam
customizationAntiscamBackgroundColor
UIColor
Cor de fundo do texto da mensagem antiscam
customizationAntiscamCornerRadius
CGFloat
Raio dos cantos da moldura de fundo
customizationAntiscamFlashColor
UIColor
Cor do indicador piscante próximo à mensagem antiscam
logoCustomization
Parâmetros de personalização do logo. Um logo personalizado deve ser permitido pela licença. Por padrão, o logo é posicionado no canto inferior esquerdo.
image
UIImage
Imagem do logo
size
CGSize
Tamanho do logo (em dp)
verticalPosition
Int (0-100), default: 100
Deslocamento vertical
horizontalPosition
Int (0-100), default: 0
Deslocamento horizontal
Variáveis e objetos
enum LicenseSource
Uma fonte de licença.
licenseFilePath
Um caminho absoluto para uma licença (String)
licenseFileName
O nome do arquivo de licença
struct LicenseData
Os dados da licença.
appIDS
[String]
Uma matriz de IDs de bundle
expires
TimeInterval
O intervalo de expiração
features
Features
Recursos da licença
configs (optional)
ABTestingConfigs
Configuração adicional
enum OzVerificationMovement
Contém a ação do vídeo capturado.
Em 1º de janeiro de 2027, o gesto One Shot ficará indisponível. Planeje sua migração.
smile
Smile
eyes
Piscar
escaneamento
Escanear
selfie
Uma selfie com verificação de alinhamento facial
one_shot
A melhor captura do vídeo gravado
left
Cabeça virada para a esquerda
right
Cabeça virada para a direita
down
Cabeça inclinada para baixo
up
Cabeça levantada
enum OZLocalizationCode
Contém o código de localidade de acordo com ISO 639-1.
en
Inglês
hy
Armênio
kk
Cazaque
ky
Quirguiz
tr
Turco
es
Espanhol
pt-BR
Português (brasileiro)
custom(String)
Idioma personalizado (código ISO 639-1 do idioma, duas letras)
struct OZMedia
Contém todas as informações sobre a mídia capturada.
metaData
[String] da seguinte forma:
["meta1": "data1"]
Metadados, se houver
videoURL
URL
URL do vídeo de Liveness
bestShotURL
URL
URL da melhor captura em PNG
preferredMediaURL
URL
URL do contêiner de mídia da API
timestamp
Data
Carimbo de data/hora para a conclusão da verificação
enum MediaType
O tipo de mídia capturada.
movement
Uma mídia com uma ação
documentBack
O verso do documento
documentFront
A frente do documento
enum OZVerificationStatus
Descrição do erro.
userNotProcessed
A verificação de Liveness não foi processada
failedBecauseUserCancelled
A verificação foi interrompida pelo usuário
failedBecauseCameraPermissionDenied
A verificação de Liveness não pode ser executada: sem acesso à câmera
failedBecauseOfBackgroundMode
A verificação de Liveness não pode ser executada: modo em segundo plano
failedBecauseOfTimeout
A verificação de Liveness não pode ser executada: tempo limite esgotado
failedBecauseOfAttemptLimit
A verificação de Liveness não pode ser executada: limite de tentativas excedido
failedBecausePreparingTimout
A verificação de Liveness não pode ser executada: tempo limite de alinhamento facial
failedBecauseOfLowMemory
A verificação de Liveness não pode ser executada: sem memória disponível
struct Analysis
Contém informações sobre qual mídia analisar e quais análises aplicar.
sizeReductionStrategy
Define qual tipo de mídia é enviada ao servidor no caso da análise híbrida, assim que a análise no dispositivo for concluída com sucesso
params (optional)
String
Parâmetros adicionais
enum AnalysisType
O tipo da análise.
biometry
O algoritmo que permite comparar várias mídias e verificar se as pessoas nelas são a mesma pessoa ou não
quality
O algoritmo que tem como objetivo verificar se uma pessoa em um vídeo é um ser humano real agindo de boa-fé, e não uma falsificação de qualquer tipo.
document (deprecated)
A análise que visa reconhecer o documento e verificar se seus campos estão corretos de acordo com o tipo dele.
blacklist
A análise que compara um rosto em uma mídia capturada com rostos do banco de dados de mídias predefinidas.
Atualmente, a análise .document não pode ser executada no modo onDevice.
enum AnalysisMode
O modo da análise.
onDevice
A análise onDevice sem necessidade de servidor. Recomendamos usar análises baseadas em servidor sempre que possível, pois as análises onDevice tendem a produzir resultados menos precisos
serverBased
A análise baseada em servidor
hybrid
A análise híbrida para Liveness: se a pontuação recebida de uma análise onDevice for alta demais, o sistema inicia uma análise baseada em servidor como verificação adicional.
enum ScenarioState
Mostra o status de processamento da mídia.
addToFolder
O sistema está criando uma pasta e adicionando arquivos a essa pasta
addAnalyses
O sistema está adicionando análises
waitAnalysisResult
O sistema está aguardando o resultado
struct AnalysisStatus
Mostra o status de envio dos arquivos.
index
Int
Número deste objeto em uma lista
from
Int
Quantidade de objetos
progress
Progresso
Status de envio do objeto
RequestStatus
Mostra o status de processamento da análise.
ResultMedia
Descreve o resultado da análise para uma única mídia.
sourceId
String
Identificador da mídia
isOnDevice
Bool
Modo de análise
confidenceScore
Float
Pontuação resultante
mediaType
String
Tipo de arquivo de mídia: VIDEO / IMAGE / SHOT_SET
erro
AnalysisError (inherits from Error)
Erro
RequestResult
Contém os resultados consolidados da análise para todas as mídias.
folderId
String
Identificador da pasta
class AnalysisResult
Contém os resultados das verificações realizadas.
analysisId
String
Identificador da análise
erro
AnalysisError (inherits from Error)
Erro
confidenceScore
Float
A pontuação resultante
serverRawResponse
String
Resposta do servidor
enum AnalyseResolutionStatus
O status geral de todas as análises aplicadas à pasta criada.
INITIAL
Nenhuma análise foi aplicada ainda
PROCESSING
As análises estão em andamento
FAILED
Uma ou mais análises falharam devido a algum erro e não puderam ser concluídas
FINISHED
As análises foram concluídas
DECLINED
A verificação falhou (por exemplo, os rostos não correspondem ou algum ataque de spoofing foi detectado)
SUCCESS
Tudo correu bem, a verificação foi bem-sucedida (por exemplo, os rostos correspondem ou Liveness confirmada)
OPERATOR_REQUIRED
O resultado deve ser verificado adicionalmente por um operador humano
struct AnalyseResolution
Contém os resultados de análises individuais.
folderID
String
O identificador da pasta
score
Float
O resultado da verificação realizada
enum GeometryType
Configurações do formato da moldura.
oval
Moldura oval
rectangle(cornerRadius: CGFloat)
Moldura retangular (com raio dos cantos)
circle
Moldura circular
square(cornerRadius: CGFloat)
Moldura quadrada (com raio dos cantos)
enum LicenseError
Possíveis erros de licença.
licenseFileNotFound
A licença não foi encontrada
licenseParseError
Não é possível analisar o arquivo de licença; a licença pode ser inválida
licenseBundleError
O bundle_id no arquivo de licença não corresponde ao bundle_id usado
licenseExpired
A licença expirou
enum Connection
O tipo de autorização.
struct UploadMediaSettings
Define as configurações para o envio repetido de mídia.
attemptsCount
Int
Número de tentativas de envio de mídia
attemptsTimeout
Int
Tempo limite entre as tentativas
enum SizeReductionStrategy
Define qual tipo de mídia é enviada ao servidor no caso da análise híbrida, assim que a análise no dispositivo for concluída com sucesso. Por padrão, o sistema envia o vídeo compactado.
uploadOriginal
O vídeo original
uploadCompressed
O vídeo compactado
uploadBestShot
A melhor captura extraída do vídeo
uploadNothing
Nada é enviado (observe que nenhuma pasta será criada)
sslPin
Contém informações sobre os certificados permitidos.
publicKeyHash
String
Hash da chave SHA256 em base64
expirationDate
carimbo de data/hora UNIX, horário UTC
A data de expiração do certificado
environment
Define qual ambiente usar.
O modo .debug deve ser usado apenas durante o desenvolvimento e os testes ativos. Todas as compilações destinadas a usuários finais devem ser configuradas para usar o modo .production para manter a postura de segurança e os requisitos de conformidade esperados de implantações em produção.
debug
A rigidez das verificações de segurança do SDK é reduzida para que o aplicativo possa ser executado com um depurador anexado. Destinado ao desenvolvimento e à depuração
production (default)
Todas as verificações de segurança estão habilitadas. Destinado a compilações de release
O método afeta apenas as verificações de segurança; a funcionalidade do SDK não muda.
Contêiner de dados OzCapsula
Os métodos abaixo se aplicam ao novo recurso – Contêiner de dados OzCapsula que foi implementado na versão 8.22.
addContainer
Este método substitui addAnalysis na AnalysisRequest estrutura quando você usa o fluxo de contêiner de dados.
Entrada
DataContainer
Data
Um arquivo criptografado contendo mídia e informações complementares, a saída do createMediaCaptureScreen método
createMediaCaptureScreen
Captura o arquivo de mídia com todas as informações necessárias e o empacota em um contêiner de dados.
Entrada
session_token
String
Token necessário para o fluxo OzCapsula
Saída
DataContainer
Data
Um arquivo criptografado contendo mídia e informações complementares
public data class CaptureRequest
Detecta uma solicitação de captura de vídeo.
analysisProfileList
List<AnalysisProfile>
Uma lista de objetos que contêm informações sobre mídias e análises que devem ser aplicadas a elas
folderMeta (optional)
Map<String, Any>
Metadados adicionais da pasta
additionalMediaList (optional)
List<MediaRequest>
Arquivos de mídia que precisam ser enviados ao servidor, mas não são necessários para as análises
cameraPosition (optional)
String
front (padrão) – câmera frontal
back – câmera traseira
public data class AnalysisProfile
Contém informações sobre arquivos de mídia e análises que devem ser aplicadas a eles.
params (optional)
Map<String, Any>
Parâmetros adicionais de análise
public sealed class MediaRequest
Armazena informações sobre um arquivo de mídia.
Observação: adicione actionMedia OU userMedia, esses parâmetros são mutuamente exclusivos.
id
String (UUID v4)
ID da mídia
Erros do contêiner de dados
session_token_is_empty
O session_token não deve estar vazio
session_token ausente, que é um parâmetro obrigatório
data_container_internal_failure_1
Ocorreu uma falha interna ao processar o contêiner de dados
Memória insuficiente
data_container_internal_failure_2
data_container_internal_failure_3
data_container_internal_failure_4
Ocorreu uma falha interna ao processar o contêiner de dados
Não foi possível gerar um contêiner
data_container_internal_failure_1000
Ocorreu uma falha interna ao processar o contêiner de dados
Qualquer outro erro não mencionado acima
Se, durante o processo de captura, um erro impedir o usuário de concluir o fluxo de trabalho, o contêiner de dados será excluído.
Atualizado
Isto foi útil?