O objeto FaceReconOptions

Parâmetros de startFaceRecon

Parâmetro	Tipo	Função	Obrigatório
environment	CaaSEnvironment	Enumerador utilizado para configurar o ambiente de execução para sandbox ou production.	Sim.
clientSessionKey	String	Chave temporária de autenticação obtida por meio de requisição server-to-server à API de Reconhecimento facial. Veja Implementação.	Sim.
options	FaceReconOptions?	Objeto opcional com as customizações visuais, textuais e de comportamento do SDK.	Não.

FaceReconOptions

Todos os campos são opcionais. Quando um campo não é informado, o SDK nativo aplica o seu valor padrão.

Parâmetro	Tipo	Função	Padrão
sessionId	String?	Chave que identifica a sessão iniciada no SDK. É utilizada para rastrear todo o fluxo percorrido pelo usuário através de logs. Aceita até 255 caracteres.	Gerado internamente.
documentNumber	String?	Número do documento do usuário (CPF), utilizado exclusivamente para identificação antifraude.	Não enviado.
fontColor	String?	Cor da fonte e dos ícones das telas do SDK, em formato hexadecimal (ex.: "#FFFFFF").	"#000000"
backgroundColor	String?	Cor de fundo das telas do SDK, em formato hexadecimal (ex.: "#000000").	"#FFFFFF"
fontFamily	CaaSFontFamily?	Fonte utilizada nas telas do SDK.	CaaSFontFamily.openSans
showIntroductionScreens	bool?	Quando false, desativa as telas de introdução à prova de vida.	true
showSuccessScreen	bool?	Quando false, desativa a tela de sucesso exibida após a captura.	true
showInvalidTokenScreen	bool?	Quando false, desativa a tela exibida quando o clientSessionKey é inválido ou expirou.	true
audioConfiguration	FaceReconAudioConfiguration?	Configura o guiamento por voz, que narra as instruções de captura em tempo real.	FaceReconAudioConfiguration.disable
onboardingTextConfiguration	OnboardingTextConfiguration?	Customiza os textos da tela de onboarding.	Textos padrão do SDK.
logLevel	CaaSLogLevel?	Nível de verbosidade dos logs do SDK.	CaaSLogLevel.debug

Atenção

A partir da versão 5.0.0 do plugin, o campo documentNumber não dispara mais o registro de face — ele é utilizado somente para identificação antifraude.

OnboardingTextConfiguration

Parâmetro	Tipo	Função
onboardingTitle	String?	Título da tela de onboarding.
onboardingFirstLabel	String?	Primeira instrução exibida ao usuário.
onboardingSecondLabel	String?	Segunda instrução exibida ao usuário.
onboardingThirdLabel	String?	Terceira instrução exibida ao usuário.

OnboardingTextConfiguration(
  onboardingTitle: 'Conselhos relevantes',
  onboardingFirstLabel: 'Esteja com o rosto visível',
  onboardingSecondLabel: 'Encaixe seu rosto no oval',
  onboardingThirdLabel: 'Retire acessórios que cubram o rosto',
)

Enumeradores

CaaSEnvironment

enum CaaSEnvironment {
  production,
  sandbox,
}

CaaSFontFamily

enum CaaSFontFamily {
  jakarta,       // apenas iOS
  futura,        // iOS e Android
  verdana,       // iOS e Android
  trebuchetMs,   // apenas iOS
  tamilsangamMn, // apenas iOS
  openSans,      // iOS e Android
  helvetica,     // apenas Android
  poppins,       // apenas Android
  roboto,        // apenas Android
  systemFont,    // apenas iOS
}

Atenção

A disponibilidade das fontes varia por plataforma. Caso uma fonte não suportada seja informada, a plataforma utiliza a sua fonte padrão. Para consistência entre iOS e Android, utilize futura, verdana ou openSans.

FaceReconAudioConfiguration

enum FaceReconAudioConfiguration {
  enable,        // exibe o botão de áudio, com a narração iniciando desligada
  disable,       // desativa a narração e oculta o botão
  accessibility, // exibe o botão com a narração iniciando ligada quando há recursos de acessibilidade ativos
}

CaaSLogLevel

enum CaaSLogLevel {
  trace,
  debug,
  log,
  info,
  warn,
  error,
}