Métodos e propriedades do Flutter SDK

clearActionVideos

Exclui todos os vídeos de ação do sistema de arquivos (iOS 8.4.0 e mais recentes, Android).

Retorna

Future<Void>.

getSDKVersion

Retorna a versão do SDK.

Retorna

Future<String>.

initSDK

Inicializa o SDK com fontes de licença.

Parâmetro	Tipo	Descrição
licenses	List<String>	Uma lista de licenças

Retorna

Caso	Texto
True	A inicialização foi concluída com sucesso
False	Erro de inicialização

setApiConnectionWithCredentials

Autenticação via credenciais.

Parâmetro	Tipo	Descrição
e-mail	String	E-mail do usuário
senha	String	Senha do usuário
host	String	URL do servidor
sslPins (opcional)	sslPin	Certificados permitidos

Retorna

Caso	Texto
SUCCESS	Nada (void)
FAILED	PlatformException: code = AUTHENTICATION_FAILED message = detalhes da exceção

setApiConnectionWithToken

Autenticação via token de acesso.

Parâmetro	Tipo	Descrição
token	String	Token de acesso
host	String	URL do servidor
sslPins (opcional)	sslPin	Certificados permitidos

Retorna

Caso	Texto
SUCCESS	Nada (void)
FAILED	PlatformException: code = AUTHENTICATION_FAILED message = detalhes da exceção

setEventConnectionWithCredentials

Conexão com o servidor de telemetria via credenciais.

Parâmetro	Tipo	Descrição
e-mail	String	E-mail do usuário
senha	String	Senha do usuário
host	String	URL do servidor
sslPins (opcional)	sslPin	Certificados permitidos

Retorna

Caso	Texto
SUCCESS	Nada (void)
FAILED	PlatformException: code = AUTHENTICATION_FAILED message = detalhes da exceção

setEventConnectionWithToken

Conexão com o servidor de telemetria via token de acesso.

Parâmetro	Tipo	Descrição
token	String	Token de acesso
host	String	URL do servidor
sslPins (opcional)	sslPin	Certificados permitidos

Retorna

Caso	Texto
SUCCESS	Nada (void)
FAILED	PlatformException: code = AUTHENTICATION_FAILED message = detalhes da exceção

isLoggedIn

Verifica se existe um token de acesso.

Retorna

Caso	Retorna
O token existe	True
O token não existe	False

logout

Exclui o token de acesso salvo.

Retorna

Nada (void).

supportedLanguages

Retorna a lista de idiomas suportados pelo SDK.

Retorna

List<Locale>.

startLiveness

Inicia o processo de captura de vídeo do Liveness.

Parâmetro	Tipo	Descrição
actions	List<VerificationAction>	Ações a executar
mainCamera	Boolean	Use a câmera principal (True) ou frontal (False)

setSelfieLength

Define a duração do Selfie gesto (em milissegundos).

Parâmetro	Tipo	Descrição
selfieLength	Int	A duração do Selfie gesto (em milissegundos). Deve estar entre 500-5000 ms, a duração padrão é 700

Retorna

Erro, se houver.

Analyze

Inicia as análises.

Parâmetro	Tipo	Descrição
analysis	List<Análise>	A lista de estruturas de análise
folder ID (opcional)	String	ID da pasta, se quiser realizar uma análise para uma pasta específica
uploadMedia	List<Mídia>	A lista dos vídeos capturados
params	Map<String, Any>	Parâmetros adicionais

Retorna

List<RequestResult>.

setLocalization (Android) / setLocalizationValue (iOS)

Define a localidade do SDK.

Parâmetro	Tipo	Descrição
locale	Locale	O idioma do SDK

attemptSettings

O número de tentativas antes que o SDK retorne um erro.

Parâmetro	Tipo	Descrição
singleCount	int	Tentativas em uma única ação/gesto
commonCount	int	Número total de tentativas em todas as ações/gestos se uma sequência deles for usada

setUICustomization

Define os valores de personalização da interface do usuário para OzLivenessSDK. Os valores são descritos na estruturas de personalização seção. As estruturas podem ser encontradas no arquivo lib\customization.dart.

setFaceAlignmentTimeout

Define o tempo limite para o alinhamento facial das ações.

Parâmetro	Tipo	Descrição
timeout	int	Tempo limite em milissegundos

Fontes e outros recursos personalizados

Para iOS

Adicione fontes e recursos drawable ao application/ios projeto.

Para Android

Fontes e imagens devem ser colocadas nas pastas correspondentes:

ozforensics_flutter_plugin\android\src\main\res\drawable ozforensics_flutter_plugin\android\src\main\res\font

estruturas de personalização

Eles são definidos no arquivo customization.dart.

UICustomization

Contém as informações sobre os parâmetros de personalização.

ToolbarCustomization

Parâmetros de personalização da barra de ferramentas.

Parâmetro	Tipo	Descrição
closeButtonIcon	String	Ícone do botão Fechar recebido do plugin
closeButtonColor	String	Cor #XXXXXX
titleText	String	Texto do cabeçalho
titleFont	String	Fonte do texto
titleSize	int	Tamanho da fonte
titleFontStyle	String	Estilo da fonte
titleColor	String	Cor #XXXXXX
titleAlpha	int	Opacidade do texto do cabeçalho
isTitleCentered	bool	Centraliza o texto
backgroundColor	String	Cor de fundo do cabeçalho #XXXXXX
backgroundAlpha	int	Opacidade do fundo do cabeçalho

CenterHintCustomization

Parâmetros de personalização da dica central.

Parâmetro	Tipo	Descrição
textFont	String	Fonte do texto
textFontStyle	String	Estilo da fonte
textColor	String	Cor #XXXXXX
textSize	int	Tamanho da fonte
verticalPosition	int	Posição Y
textAlpha	int	Opacidade do texto
centerBackground	bool	Centraliza o texto

HintAnimation

Parâmetros de personalização da animação da dica.

Parâmetro	Tipo	Descrição
hideAnimation	bool	Oculta a animação da dica
animationIconSize	int	Tamanho do ícone da animação em px (40-160)
hintGradientColor	String	Cor #XXXXXX
hintGradientOpacity	int	Cor do gradiente

FaceFrameCustomization

Parâmetros de personalização da moldura ao redor do rosto.

Parâmetro	Tipo	Descrição
geometryType	String	Formato da moldura recebido do plugin
geometryTypeRadius	int	Raio dos cantos do retângulo
strokeWidth	int	Largura do traço da moldura
strokeFaceNotAlignedColor	String	Cor #XXXXXX
strokeFaceAlignedColor	String	Cor #XXXXXX
strokeAlpha	int	Opacidade do traço
strokePadding	int	Espaçamento do traço

VersionLabelCustomization

Parâmetros de personalização da versão do SDK.

Parâmetro	Tipo	Descrição
textFont	String	Fonte do texto
textFontStyle	String	Estilo da fonte
textColor	String	Cor #XXXXXX
textSize	int	Tamanho da fonte
textAlpha	int	Opacidade do texto

BackgroundCustomization

Parâmetros de personalização do plano de fundo.

Parâmetro	Tipo	Descrição
backgroundColor	String	Cor #XXXXXX
backgroundAlpha	int	Opacidade do plano de fundo

Estruturas do Flutter

Definidas no arquivo models.dart.

enum Locale

Armazena as informações do idioma.

Caso	Descrição
en	Inglês
hy	Armênio
kk	Cazaque
ky	Quirguiz
tr	Turco
es	Espanhol
pt_br	Português (brasileiro)

enum MediaType

O tipo de mídia capturada.

Caso	Descrição
movimento	Uma mídia com uma ação
documentBack	O verso do documento
documentFront	A frente do documento

enum FileType

O tipo de mídia capturada.

Caso	Descrição
documentPhoto	Uma foto de um documento
video	Um vídeo
shotSet	Um arquivo de quadros

enum MediaTag

Contém uma ação do vídeo capturado.

O Captura única gesture está sendo descontinuado. O suporte terminará em 31 de dezembro de 2026. Planeje sua migração.

Caso	Descrição
blank	Um vídeo sem gesto
photoSelfie	Uma foto de selfie
videoSelfieOneShot	Um vídeo com a melhor captura obtida
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

Mídia

Armazena informações sobre a mídia.

Parâmetro	Tipo	Descrição	Platform
fileType	FileType	O tipo do arquivo	Android
movimento	VerificationAction	Uma ação em uma mídia	iOS
mediatype	String	Um tipo de mídia	iOS
videoPath	String	Um caminho para um vídeo
bestShotPath	String	caminho da melhor captura em PNG para vídeo ou caminho da imagem para Liveness
preferredMediaPath	String	URL do contêiner de mídia da API
photoPath	String	Um caminho para uma foto
archivePath	String	Um caminho para um arquivo
tag	MediaTag	Uma tag para a mídia	Android

RequestResult

Armazena informações sobre o resultado da análise.

Parâmetro	Tipo	Descrição	Platform
folderId	String	O identificador da pasta
tipo	Tipo	O tipo da análise
errorCode	int	O código de erro	Somente Android
errorMessage	String	A mensagem de erro
mode	Modo	O modo da análise
confidenceScore	Double	A pontuação resultante
resolution	Resolução	O resultado da análise concluída
status	Boolean	O estado da análise: true- success; false- failed

Análise

Armazena dados sobre uma única análise.

Parâmetro	Tipo	Descrição
tipo	Tipo	O tipo da análise
mode	Modo	O modo da análise
mediaList	List<Mídia>	Mídia a analisar
params	Map<String, String>	Parâmetros adicionais de análise
sizeReductionStrategy	SizeReductionStrategy	Define qual tipo de mídia é enviada ao servidor no caso da análise híbrida, assim que a análise no dispositivo é concluída com sucesso

Estruturas

enum Type

Tipo de análise.

Caso	Descrição
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 ser humano real agindo de boa-fé, e não uma falsificação de qualquer tipo.

enum Mode

Modo de análise.

Caso	Descrição
onDevice	A análise no dispositivo sem necessidade de servidor
serverBased	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 muito alta, o sistema inicia uma análise baseada em servidor como verificação adicional.

enum VerificationAction

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.

Caso	Descrição
oneShot	A melhor captura do vídeo gravado
blank	Uma selfie com verificação de alinhamento do rosto
scan	Escanear
headRight	Cabeça virada para a direita
headLeft	Cabeça virada para a esquerda
headDown	Cabeça inclinada para baixo
headUp	Cabeça erguida
eyeBlink	Blink
smile	Smile

Resolução

O status geral de todas as análises aplicadas à pasta criada.

Caso	Descrição
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 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)
operatorRequired	O resultado deve ser verificado adicionalmente por um operador humano

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 é 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 na whitelist.

Parâmetro	Tipo	Descrição
hash	String	Hash da chave SHA256 em base64
expired_at	Timestamp UNIX, horário UTC	A data de expiração do certificado, ms

Recursos de personalização

Este é um Map para definir os recursos específicos da plataforma no nível do plugin.

closeButtonIcon

Esta chave é um Map para o ícone do botão Fechar.

Chave	Valor
Fechar	Recurso drawable do Android / recurso Pods do iOS
Seta	Recurso drawable do Android / recurso Pods do iOS

titleFont

Esta chave é um Map contendo os dados das fontes enviadas.

Chave	Valor
Nome da fonte da aplicação Flutter	Recurso de fonte do Android / recurso Pods do iOS, usado para recuperar a fonte no nível do plugin

titleStyle

Esta chave é um Map contendo os dados dos estilos de fonte enviados.

Chave	Valor
Nome do estilo de fonte da aplicação Flutter	Nome do estilo recuperado para a criação da fonte no nível do plugin

faceFrameGeometry

Esta chave é um Map contendo os dados da forma da moldura.

Chave	Valor
Oval	Forma oval
Rectangle	Forma retangular

contêiner de dados OzCapsula

Os métodos abaixo se aplicam ao novo recurso – contêiner de dados OzCapsula que foi implementado na 9.1.0.

createMediaCaptureScreen

Captura o arquivo de mídia com todas as informações necessárias e o empacota em um contêiner de dados.

Parâmetro	Tipo	Descrição
solicitação	CaptureRequest	Detecta uma solicitação de captura de vídeo
sessionToken	String	Token necessário para o fluxo OzCapsula

Retorna

Void. O contêiner capturado é entregue por meio do livenessResult stream: Stream<DataContainer>.

getContainerBytes

Recupera os bytes brutos de um contêiner de dados. Use isto ao enviar a mídia ao backend por conta própria.

Parâmetro	Tipo	Descrição
dataContainer	DataContainer	O contêiner de dados capturado, resultado de createMediaCaptureScreen solicitação

Retorna

Future<Uint8List?>.

analyze (fluxo de contêiner de dados)

Esta assinatura substitui uploadMedia no método analyze quando o fluxo de contêiner de dados é usado.

Parâmetro	Tipo	Descrição
analysis	List<Análise>	A lista de estruturas de análise
dataContainer	DataContainer	O contêiner de dados capturado, resultado de createMediaCaptureScreen solicitação

Retorna

List<RequestResult>.

CaptureRequest

Detecta uma solicitação de captura de vídeo.

Parâmetro	Tipo	Descrição
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, dynamic>	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 (opcional)	CameraPosition	front (padrão) – câmera frontal; back – câmera traseira

AnalysisProfile

Contém informações sobre arquivos de mídia e análises que devem ser aplicadas a eles.

Parâmetro	Tipo	Descrição
tipo	Tipo	Tipo de análise
mediaList	List<MediaRequest>	Uma lista de mídias a serem analisadas
params (opcional)	Map<String, dynamic>	Parâmetros adicionais de análise

MediaRequest

Armazena informações sobre um arquivo de mídia.

Observe: você deve adicionar actionMedia OU userMedia, esses parâmetros são mutuamente exclusivos.

Parâmetro	Tipo	Descrição
id (opcional)	String (UUID v4)	ID da mídia. Gerado automaticamente se não for fornecido
actionMedia	ActionMedia	Uma ação que o usuário deve realizar em um vídeo
userMedia	UserMedia	Um arquivo de mídia externo, por exemplo, uma referência ou uma foto de documento
mediaMeta (opcional)	Map<String, dynamic>	Metadados da mídia

ActionMedia

Um arquivo de mídia com uma ação que o usuário deve executar.

Parâmetro	Tipo	Descrição
action	VerificationAction	Uma ação que o usuário deve realizar em um vídeo
id (opcional)	String (UUID v4)	ID da mídia. Gerado automaticamente se não for fornecido
mediaMeta (opcional)	Map<String, dynamic>	Metadados da mídia

UserMedia

Um arquivo de mídia externo, por exemplo, uma referência ou uma foto de documento.

Parâmetro	Tipo	Descrição
media	Mídia	O arquivo de mídia externo
id (opcional)	String	ID da mídia
mediaMeta (opcional)	Map<String, dynamic>	Metadados da mídia