Métodos e propriedades do Android SDK
OzLivenessSDK
Um singleton para Oz SDK.
clearActionVideos
Exclui todos os vídeos de ação do sistema de arquivos.
Parâmetros
-
Retorno
-
createStartIntent
Cria um intent para iniciar a atividade Liveness.
Retorno
-
getErrorFromIntent
Função utilitária para obter o erro do SDK a partir do intent de OnActivityResult.
data
Intent
O objeto a ser testado
Retorno
O texto de erro – String.
getLicensePayload
Recupera o payload de licença do SDK.
Parâmetros
-
Retorno
O payload de licença (LicensePayload) – o objeto que contém as informações estendidas sobre as condições de licenciamento.
getResultFromIntent
Função utilitária para obter resultados do SDK a partir do intent de OnActivityResult.
data
Intent
O objeto a ser testado
Retorno
Uma lista de objetos OzAbstractMedia.
init
Inicializa o SDK com fontes de licença.
context
Context
A classe Context
statusListener
StatusListener
Ouvinte opcional para verificar o resultado do carregamento da licença
Retorno
-
log
Habilita o logging usando o mecanismo de logging do Oz Liveness SDK.
tag
String
Tag da mensagem
log
String
Log da mensagem
Retorno
-
setApiConnection
Define a conexão com Oz API.
statusListener
StatusListener<String?>
Ouvinte
setEventsConnection
Define a conexão com o servidor de telemetria.
statusListener
StatusListener<String?>
Ouvinte
logout
Exclui o token salvo.
Parâmetros
-
Retorno
-
getEventSessionId
Recupera o ID da sessão de telemetria.
Parâmetros
-
Retorno
O ID da sessão de telemetria (String).
version
Recupera a versão do SDK.
Parâmetros
-
Retorno
A versão do SDK (String).
generateSignedPayload
Gera o payload com assinaturas de mídia.
folderMeta (optional)
[string:any]
Metadados adicionais da pasta
Retorno
Payload a ser enviado junto com os arquivos de mídia usados para a geração.
setEnvironment
Define o ambiente do SDK para debug ou produção.
AnalysisRequest
Uma classe para realizar verificações.
run
O método de execução da análise.
onStatusChange
Uma função de callback da seguinte forma:
onStatusChange(status: AnalysisRequest.AnalysisStatus) { handleStatus() }
A função é executada quando o status de AnalysisRequest é alterado
onError
Uma função de callback da seguinte forma:
onError(error: OzException) { handleError() }
A função é executada em caso de erro
onSuccess
A função é executada quando todas as análises são concluídas
class Builder
Uma classe builder para AnalysisRequest.
build
Cria a instância de AnalysisRequest.
Parâmetros
-
Retorno
O AnalysisRequest instância da classe.
addAnalysis
Adiciona uma análise à sua solicitação.
Retorno
Erro, se houver.
addAnalyses
Adiciona uma lista de análises à sua solicitação. Permite executar várias análises para a mesma pasta no lado do servidor.
Retorno
Erro, se houver.
addFolderMeta
Adiciona metadados a uma pasta que você criar (apenas para as análises baseadas no servidor). É possível adicionar um par chave-valor como informação adicional à pasta com o resultado da análise no lado do servidor.
key
String
Chave para metadados
value
String
Valor para metadados
Retorno
Erro, se houver.
uploadMedia
Faz upload de uma ou mais mídias para uma pasta.
Retorno
Erro, se houver.
setFolderId
Para a pasta criada anteriormente, define um folderId. A pasta deve existir no lado do servidor. Caso contrário, uma nova pasta será criada.
folderID
String
Um identificador de pasta
Retorno
Erro, se houver.
useInstantMode
Gerencia a interação com Instant API. Defina como true para habilitar o modo de API não persistente (useInstantMode(true)).
OzConfig
Configuração para OzLivenessSDK (use OzLivenessSDK.config).
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, o valor padrão é 700
Retorno
Erro, se houver.
allowDebugVisualization
A possibilidade de habilitar informações adicionais de debug ao clicar no texto da versão.
allowDebugVisualization
Boolean
Habilita ou desabilita as informações de debug
attemptSettings
O número de tentativas antes de o SDK retornar um erro.
uploadMediaSettings
Configurações para upload repetido de mídia.
faceAlignmentTimeout
Tempo limite para alinhamento facial (medido em milissegundos).
faceAlignmentTimeout
Long
Um valor de timeout
livenessErrorCallback
Implementação de interface para recuperar o erro da detecção de Liveness.
livenessErrorCallback
ErrorHandler
Um valor de callback
localizationCode
Locale para exibir recursos de string.
logging
Configurações de logging.
useMainCamera
Usa a câmera principal (traseira) em vez da câmera frontal para detecção de Liveness.
useMainCamera
Boolean
True – câmera traseira,
False – câmera frontal
disableFramesCountValidation
Desativa a opção que impede que os vídeos fiquem curtos demais (3 frames ou menos).
disableFramesCountValidation
Boolean
True – a validação está desativada,
False – a validação está ativada
UICustomization
Personalização para OzLivenessSDK (use OzLivenessSDK.config.customization).
hideStatusBar
Oculta a barra de status e os três botões na parte inferior. O valor padrão é True.
toolbarCustomization
Um conjunto de parâmetros de personalização para a toolbar.
closeIconRes
Int (@DrawableRes)
Uma imagem para o botão de fechar
titleTextFont
Int (@FontRes)
Fonte do texto do título da toolbar
titleTextFontStyle
Int (values from android.graphics.Typeface properties, e.g., Typeface.BOLD)
Estilo da fonte do texto do título da toolbar
titleTextSize
Int
Tamanho do texto do título da toolbar (em sp, 12-18)
titleTextAlpha
Int
Opacidade do texto do título da toolbar (em %, 0-100)
backgroundAlpha
Int
Opacidade do fundo da toolbar (em %, 0-100)
isTitleCentered
Boolean
Define se o texto na toolbar é centralizado ou não
title
String
Texto na toolbar
centerHintCustomization
Um conjunto de parâmetros de personalização para a dica central que orienta o usuário no processo de capturar uma imagem de si mesmo.
textFont
String
Fonte do texto da dica central
textStyle
Int (values from android.graphics.Typeface properties, e.g.,Typeface.BOLD)
Estilo do texto da dica central
textSize
Int
Tamanho do texto da dica central (em sp, 12-34)
textAlpha
Int
Opacidade do texto da dica central (em %, 0-100)
verticalPosition
Int
Posição vertical da dica central a partir da parte inferior da tela (em %, 0-100)
backgroundOpacity
Int
Opacidade do fundo da dica central
backgroundCornerRadius
Int
Raio dos cantos da moldura de fundo da dica central (em dp, 0-20)
hintAnimation
Um conjunto de parâmetros de personalização para a animação da dica.
hintGradientOpacity
Int
Opacidade do gradiente
animationIconSize
Int
Tamanho lateral do quadrado do ícone da animação
hideAnimation
Boolean
Um seletor para a animação da dica, se True, a animação é ocultada
faceFrameCustomization
Um conjunto de parâmetros de personalização para a moldura ao redor do rosto do usuário.
cornerRadius
Int
Raio dos cantos do retângulo (em dp, 0-20)
strokeAlpha
Int
Opacidade da moldura (em %, 0-100)
strokeWidth
Int
Largura do traço da moldura (em dp, 0-20)
strokePadding
Int
Um espaçamento entre o traço e 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.
backgroundAlpha
Int
Opacidade do fundo (em %, 0-100)
versionTextCustomization
Um conjunto de parâmetros de personalização para o texto da versão do SDK.
textFont
Int (@FontRes)
Fonte do texto da versão do SDK
textSize
Int
Tamanho do texto da versão do SDK (em sp, 12-16)
textAlpha
Int
Opacidade do texto da versão do SDK (em %, 20-100)
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.
textMessage
String
Texto da mensagem antiscam
textFont
String
Fonte do texto da mensagem antiscam
textSize
Int
Tamanho do texto da mensagem antiscam (em px, 12-18)
textAlpha
Int
Opacidade do texto da mensagem antiscam (em %, 0-100)
backgroundOpacity
Int
Opacidade do fundo da mensagem antiscam
cornerRadius
Int
Raio dos cantos da moldura de fundo (em px, 0-20)
logoCustomization
Parâmetros de personalização do logo. O logo personalizado deve ser permitido pela licença. Por padrão, o logo é posicionado no canto inferior esquerdo.
image
Bitmap (@DrawableRes)
Imagem do logo
size
Size
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 OzAction
Contém a ação do vídeo capturado.
Em 1º de janeiro de 2027, o gesto One Shot ficará indisponível. Por favor, planeje sua migração.
OneShot
A melhor captura obtida do vídeo
Blank
Uma selfie com verificação de alinhamento facial
Scan
Scan
HeadRight
Cabeça virada para a direita
HeadLeft
Cabeça virada para a esquerda
HeadDown
Cabeça inclinada para baixo
HeadUp
Cabeça levantada
EyeBlink
Blink
Smile
Smile
classe LicensePayload
Contém informações detalhadas sobre as condições de licenciamento.
expires
Float
O intervalo de expiração
features
Features
Recursos da licença
appIDS
List<String>
Um array de IDs de bundle
classe selada OzAbstractMedia
Uma classe para a mídia capturada que pode ser:
OzDocumentPhoto
Uma foto de documento.
photoPath
String
Um caminho absoluto para uma foto
additionalTags (opcional)
String
Tags adicionais, se necessário (incluindo as que não são do enum OzMediaTag)
metaData
Map<String, String>
Metadados da mídia
OzShotSet
Um conjunto de capturas em um arquivo compactado.
archivePath
String
Um caminho para um arquivo compactado
additionalTags (opcional)
String
Tags adicionais, se necessário (incluindo as que não são do enum OzMediaTag)
metaData
Map<String, String>
Metadados da mídia
OzVideo
Um vídeo de Liveness.
videoPath
String
Um caminho para um vídeo
bestShotPath (opcional)
String
URL da melhor captura em PNG
preferredMediaPath (opcional)
String
URL do contêiner de mídia da API
additionalTags (opcional)
String
Tags adicionais, se necessário (incluindo as que não são do enum OzMediaTag)
metaData
Map<String, String>
Metadados da mídia
enum OzMediaTag
Contém uma ação do vídeo capturado.
Em 1º de janeiro de 2027, o gesto One Shot ficará indisponível. Por favor, planeje sua migração.
Blank
Um vídeo sem gesto
PhotoSelfie
Uma foto de selfie
VideoSelfieOneShot
Um vídeo com a melhor captura extraída
VideoSelfieScan
Um vídeo com o gesto de escaneamento
VideoSelfieEyes
Um vídeo com o gesto de piscar
VideoSelfieSmile
Um vídeo com o gesto de sorrir
VideoSelfieHigh
Um vídeo com o gesto de levantar a cabeça
VideoSelfieDown
Um vídeo com o gesto de inclinar a cabeça para baixo
VideoSelfieRight
Um vídeo com o gesto de virar a cabeça para a direita
VideoSelfieLeft
Um vídeo com o gesto de virar a cabeça para a esquerda
PhotoIdPortrait
Uma foto de um documento
PhotoIdBack
Uma foto do verso do documento
PhotoIdFront
Uma foto da frente do documento
classe selada LicenseSource
Uma classe de licença que pode ser:
LicenseAssetId
Contém o ID da licença.
id
Int
ID da licença
LicenseFilePath
Contém o caminho para uma licença.
path
String
Um caminho absoluto para uma licença
classe AnalysisStatus
Uma classe de status da análise que pode ser:
RunningAnalysis
Este status significa que a análise foi iniciada.
UploadingMedia
Este status significa que a mídia está sendo enviada.
index
Int
Número deste objeto em uma lista
de
Int
Quantidade de objetos
porcentagem
Int
Percentual de conclusão
enum Type
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 visa verificar se uma pessoa em um vídeo é um humano real, agindo de boa-fé, e não uma falsificação de qualquer tipo.
DOCUMENTS (obsoleto)
A análise que visa reconhecer o documento e verificar se seus campos estão corretos de acordo com seu tipo.
Atualmente, a DOCUMENTS análise não pode ser executada no modo no dispositivo.
enum Mode
O modo da análise.
ON_DEVICE
A análise no dispositivo sem necessidade de servidor
SERVER_BASED
A análise baseada em servidor
HYBRID
A análise híbrida para Liveness: se a pontuação recebida de uma análise no dispositivo for alta demais, o sistema inicia uma análise baseada em servidor como verificação adicional.
Recomenda-se usar análises baseadas em servidor sempre que possível, pois as análises no dispositivo tendem a produzir resultados menos precisos.
classe Analysis
Contém informações sobre qual mídia analisar e quais análises aplicar.
type
Tipo
O tipo da análise
mode
Mode
O modo da análise
params (opcional)
Map<String, Any>
Parâmetros adicionais
sizeReductionStrategy
Define que 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
enum Resolution
O status geral de todas as análises aplicadas à pasta criada.
FAILED
Uma ou mais análises falharam devido a algum erro e não puderam ser concluídas
DECLINED
A verificação falhou (por exemplo, os rostos não coincidem ou foi detectado algum ataque de spoofing)
SUCCESS
Tudo correu bem, a verificação foi bem-sucedida (por exemplo, os rostos coincidem ou a Liveness foi confirmada)
OPERATOR_REQUIRED
O resultado deve ser verificado adicionalmente por um operador humano
classe OzAttemptsSettings
Contêiner das contagens de tentativas antes que o SDK retorne 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 for usada uma sequência delas
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)
classe OzLogging
Contém as configurações de logging.
allowDefaultLogging
Boolean
Permite registrar no LogCat
allowFileLogging
Boolean
Permite registrar em um arquivo interno
journalObserver
StatusListener
Um ouvinte de eventos para receber eventos de journal no lado da aplicação
classe selada Color
Uma classe de cor que pode ser (dependendo do valor recebido):
ColorRes
resId
Int
Link para a cor no sistema de recursos do Android
ColorHex
hex
String
Hexadecimal da cor (por exemplo, #FFFFFF)
ColorInt
color
Int
O valor Int de uma cor no Android
enum GeometryType
Configurações da forma da moldura.
Oval
Moldura oval
Rectangle
Moldura retangular
Circle
Moldura circular
Square
Moldura quadrada
classe AnalysisError
Classe de exceção para AnalysisRequest.
apiErrorCode
Int
Código do erro
message
String
Mensagem de erro
classe SourceMedia
Estrutura que descreve a mídia usada em AnalysisRequest.
mediaId
String
Identificador da mídia
mediaType
String
Tipo da mídia
originalName
String
Nome original da mídia
tags
List<String>
Tags da mídia
classe ResultMedia
Estrutura que descreve o resultado da análise para uma única mídia.
confidenceScore
Float
Pontuação resultante
isOnDevice
Boolean
Modo da análise
classe RequestResult
Resultado consolidado de todas as análises realizadas.
folderId
String
Identificador da pasta
classe AnalysisResult
Resultado da análise para todas as mídias às quais foi aplicada.
confidenceScore
Float
Pontuação resultante
analysisId
String
Identificador da análise
params
@RawValue Map<String, Any>
Parâmetros adicionais da pasta
serverRawResponse
String
Resposta do backend
classe OzConnection
Define o método de autenticação.
OzConnection.fromServiceToken
Autenticação via token.
host
String
Endereço da API
token
String
Token de acesso
OzConnection.fromCredentials
Autenticação via credenciais.
host
String
Endereço da API
username
String
Nome de usuário
password
String
Senha
classe OzUploadMediaSettings
Define as configurações para o envio repetido de mídia.
attemptsCount
Int
Número de tentativas para o envio de mídia
attemptsTimeout
Int
Tempo limite entre as tentativas
enum SizeReductionStrategy
Define que 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.
UPLOAD_ORIGINAL
O vídeo original
UPLOAD_COMPRESSED
O vídeo compactado
UPLOAD_BEST_SHOT
A melhor captura extraída do vídeo
UPLOAD_NOTHING
Nada é enviado (observe que nenhuma pasta será criada)
sslPin
Contém informações sobre os certificados permitidos.
hash
String
Hash da chave SHA256 em base64
expiredAt
Carimbo de data/hora UNIX, horário UTC
A data de expiração do certificado
enum Environment
Define qual ambiente usar.
O modo DEBUG deve ser usado apenas durante o desenvolvimento ativo e os testes. 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 a desenvolvimento e depuração
PRODUCTION (padrão)
Todas as verificações de segurança estão habilitadas. Destinado a compilações de lançamento
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 em 8.22.
addContainer
Este método substitui addAnalysis na AnalysisRequest estrutura quando você usa o fluxo de contêiner de dados.
Entrada
DataContainer
bytearray[]
Um arquivo criptografado contendo mídia e informações de suporte, a saída do createMediaCaptureScreen método
createMediaCaptureScreen
Captura o arquivo de mídia com todas as informações de que você precisa e o empacota em um contêiner de dados.
Entrada
session_token
String
Token exigido para o fluxo OzCapsula
Saída
DataContainer
bytearray[]
Um arquivo criptografado contendo mídia e informações de suporte
classe de dados pública CaptureRequest
Detecta uma solicitação de captura de vídeo.
analysisProfileList
List<AnalysisProfile>
Uma lista de objetos que contêm informações sobre as mídias e as análises que devem ser aplicadas a elas
folderMeta (optional)
Map<String, Any>
Metadados adicionais da pasta
additionalMediaList (opcional)
List<MediaRequest>
Arquivos de mídia que você precisa enviar ao servidor, mas que não são necessários para as análises
cameraPosition (opcional)
String
frontal (padrão) – câmera frontal
traseira – câmera traseira
classe de dados pública AnalysisProfile
Contém informações sobre arquivos de mídia e análises que devem ser aplicadas a eles.
params (opcional)
Map<String, Any>
Parâmetros adicionais de análise
classe selada pública MediaRequest
Armazena informações sobre um arquivo de mídia.
Observe: você deve adicionar actionMedia OR userMedia, esses parâmetros são mutuamente exclusivos.
id
String (UUID v4)
ID da mídia
userMedia
Um arquivo de mídia externo, por exemplo, uma referência ou uma foto de documento.
Desde 9.3.0, os arquivos são nomeados usando um identificador UUID v4 com a extensão original do arquivo. O nome original do arquivo pode ser transmitido por meio do mediaMeta campo
Descrição do erro
ERROR = 3
Erro.
Ocorreu um erro desconhecido
ATTEMPTS_EXHAUSTED_ERROR = 4
Erro. As tentativas para a ação de Liveness foram esgotadas.
O número da ação tentativas é excedido
VIDEO_RECORD_ERROR = 5
Erro na gravação de vídeo.
Ocorreu um erro durante a gravação de vídeo
FORCE_CLOSED = 7
Erro. A atividade de Liveness é encerrada forçadamente pelo aplicativo CLIENT.
Um usuário fechou a tela de Liveness durante a gravação de vídeo
DEVICE_HAS_NO_FRONT_CAMERA = 8
Erro. O dispositivo não possui câmera frontal.
Nenhuma câmera frontal encontrada
DEVICE_HAS_NO_MAIN_CAMERA = 9
Erro. O dispositivo não possui câmera principal.
Nenhuma câmera traseira encontrada
DEVICE_CAMERA_CONFIGURATION_NOT_SUPPORTED = 10
Erro. A configuração da câmera do dispositivo não é suportada.
Oz Liveness não oferece suporte à configuração da câmera do dispositivo
FACE_ALIGNMENT_TIMEOUT = 12
Erro. Tempo limite de alinhamento facial em OzLivenessSDK.config.faceAlignmentTimeout milissegundos
Limite de tempo para o alinhamento facial é excedido
ERROR = 13
A verificação foi interrompida pelo usuário
O usuário fechou a tela durante a verificação de Liveness.
Erros do contêiner de dados
session_token_is_empty
O session_token não deve estar vazio
Falta o session_token, 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?
