O objeto OcrOptions

Parâmetros de startOcr

Parâmetro	Tipo	Função	Obrigatório
environment	CaaSEnvironment	Enumerador utilizado para configurar o ambiente de execução para sandbox ou production.	Sim.
mobileToken	String	Chave do cliente que identifica que os dados coletados são provenientes do seu aplicativo. Caso ainda não tenha recebido o seu mobile-token, entre em contato com o suporte. Cada ambiente exige um token diferente.	Sim.
document	CaaSDocumentType	Enumerador que define o fluxo de captura de documentos realizado pelo usuário.	Sim.
options	OcrOptions?	Objeto opcional com as customizações visuais, textuais e de comportamento do SDK.	Não.

OcrOptions

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.
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 à captura do documento.	true
showSuccessScreen	bool?	Quando false, desativa a tela de sucesso exibida após a captura.	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

O parâmetro audioConfiguration em OcrOptions está disponível a partir da versão 5.3.0 do plugin.

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: 'Dicas Importantes',
  onboardingFirstLabel: 'Vá para um local iluminado',
  onboardingSecondLabel: 'Retire o documento do plástico',
  onboardingThirdLabel: 'Garanta que o documento está corretamente enquadrado',
)

Enumeradores

CaaSEnvironment

enum CaaSEnvironment {
  production,
  sandbox,
}

CaaSDocumentType

enum CaaSDocumentType {
  cnhFull,       // CNH brasileira aberta, em foto única
  cnhDigital,    // PDF da CNH digital brasileira
  cnh,           // CNH brasileira, frente e verso
  rg,            // RG brasileiro, frente e verso
  address,       // Comprovante de residência
  rne,           // Registro Nacional de Estrangeiro, frente e verso
  crnm,          // Carteira de Registro Nacional Migratório, frente e verso
  rgCinDigital,  // PDF do RG/CIN digital
}

Atenção

O tipo rgCinDigital está disponível a partir da versão 5.3.0 do plugin.

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,
}