O objeto FaceReconOptions

Parâmetros de startFaceRecon

Parâmetro	Tipo	Função	Obrigatório
environment	CAAS_ENVIRONMENT	Enumerador utilizado para configurar o ambiente de execução para SANDBOX ou PRODUCTION.	Sim.
client_session_key	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.

type FaceReconOptions = {
  session_id?: string;
  document_number?: string;
  font_color?: string;
  background_color?: string;
  font_family?: CAAS_FONT_FAMILY;
  show_introduction_screens?: boolean;
  show_success_screen?: boolean;
  show_invalid_token_screen?: boolean;
  audio_configuration?: FACE_RECON_AUDIO_CONFIGURATION;
  onboarding_text_configuration?: OnboardingTextConfiguration;
  log_level?: CAAS_LOG_LEVEL;
};

Parâmetro	Tipo	Função	Padrão
session_id	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.
document_number	string	Número do documento do usuário (CPF), utilizado exclusivamente para identificação antifraude.	Não enviado.
font_color	string	Cor da fonte e dos ícones das telas do SDK, em formato hexadecimal (ex.: "#FFFFFF").	"#000000"
background_color	string	Cor de fundo das telas do SDK, em formato hexadecimal (ex.: "#000000").	"#FFFFFF"
font_family	CAAS_FONT_FAMILY	Fonte utilizada nas telas do SDK.	CAAS_FONT_FAMILY.OPEN_SANS
show_introduction_screens	boolean	Quando false, desativa as telas de introdução à prova de vida.	true
show_success_screen	boolean	Quando false, desativa a tela de sucesso exibida após a captura.	true
show_invalid_token_screen	boolean	Quando false, desativa a tela exibida quando o client_session_key é inválido ou expirou.	true
audio_configuration	FACE_RECON_AUDIO_CONFIGURATION	Configura o guiamento por voz, que narra as instruções de captura em tempo real.	FACE_RECON_AUDIO_CONFIGURATION.DISABLE
onboarding_text_configuration	OnboardingTextConfiguration	Customiza os textos da tela de onboarding.	Textos padrão do SDK.
log_level	CAAS_LOG_LEVEL	Nível de verbosidade dos logs do SDK.	CAAS_LOG_LEVEL.DEBUG

Atenção

O campo document_number não dispara o registro de face — ele é utilizado somente para identificação antifraude.

OnboardingTextConfiguration

type OnboardingTextConfiguration = {
  onboarding_title?: string;
  onboarding_first_label?: string;
  onboarding_second_label?: string;
  onboarding_third_label?: string;
};

Parâmetro	Tipo	Função
onboarding_title	string	Título da tela de onboarding.
onboarding_first_label	string	Primeira instrução exibida ao usuário.
onboarding_second_label	string	Segunda instrução exibida ao usuário.
onboarding_third_label	string	Terceira instrução exibida ao usuário.

Enumeradores

CAAS_ENVIRONMENT

enum CAAS_ENVIRONMENT {
  PRODUCTION = 'production',
  SANDBOX = 'sandbox',
}

CAAS_FONT_FAMILY

enum CAAS_FONT_FAMILY {
  JAKARTA = 'jakarta',                // apenas iOS
  FUTURA = 'futura',                  // iOS e Android
  VERDANA = 'verdana',                // iOS e Android
  TREBUCHET_MS = 'trebuchetms',       // apenas iOS
  TAMILSANGAM_MN = 'tamilsangammn',   // apenas iOS
  OPEN_SANS = 'open_sans',            // iOS e Android
  HELVETICA = 'helvetica',            // apenas Android
  POPPINS = 'poppins',                // apenas Android
  ROBOTO = 'roboto',                  // apenas Android
  SYSTEM_FONT = 'system_font',        // 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 OPEN_SANS.

FACE_RECON_AUDIO_CONFIGURATION

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

CAAS_LOG_LEVEL

enum CAAS_LOG_LEVEL {
  TRACE = 'trace',
  DEBUG = 'debug',
  LOG = 'log',
  INFO = 'info',
  WARN = 'warn',
  ERROR = 'error',
}