| Parâmetro | Função | Obrigatório |
| --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---- |
| mobileToken | 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. | Sim. |
| .setSandboxEnvironment() | Caso este parâmetro seja utilizado no construtor, a biblioteca será configurada para enviar os dados ao ambiente de sandbox. Caso ausente, as requisições são enviadas para o ambiente production. | Não. |
| .showIntroductionScreens(Boolean showIntroductionScreens) | Quando "false" desativa as telas de introdução à coleta da foto que aparecem para o usuário. | Não. O padrão é "true". |
| .setShowSuccessScreen(Boolean showSuccessScreen) | Quando "false" desativa a tela de sucesso após a coleta da foto. | Não. O padrão é "true". |
| .setBackgroundColor(String backgroundColor) | Permite a configuração da cor de background das activities da SDK. | Não. O padrão é "#ffffff". |
| .setFontColor(String fontColor) | Permite a configuração da cor da fonte e dos ícones das activities da SDK. | Não. O padrão é "#000000". |
| .setFontFamily(FontFamily fontFamily) | Permite a configuração da fonte das activities da SDK. | Não. Caso não seja informada o padrão é FontFamily.open_sans. Fontes disponíveis: FontFamily.open_sans, FontFamily.futura, FontFamily.verdana, FontFamily.roboto, FontFamily.poppins e FontFamily.helvetica. | Não. |
| .activeFaceLiveness(Boolean activeFaceLiveness) | Indica se a SDK deve realizar um procedimento de captura de selfie do usuário ou de prova de vida ativa. | Não. O padrão é false. |
| .audioConfiguration(AudioConfiguration audioConfiguration) | Indica se a SDK deve ou não executar áudios de indicação para o usuário. As configurações aceitas são AudioConfiguration.enable que executa os áudios de indicação, AudioConfiguration.disable que não executa estes áudios e AudioConfiguration.accessibility que executa os áudios caso o dispositivo do usuário possua configurações de acessibilidade ativadas. | Não. O padrão é AudioConfiguration.disable. |
| .setVisualConfiguration(VisualConfiguration. visualConfiguration) | Utilizado para customizar as imagens mostradas para o usuário ao longo da execução da SDK. | Não. |
| .setTextConfiguration(TextConfiguration. textConfiguration) | Utilizado para customizar os textos da tela introdutória de onboarding mostradas para o usuário ao longo da execução da SDK. | Não. |
| .setSessionId(String sessionId) | Utilizado para definir a chave que identifica a sessão iniciada na SDK. É usada para rastrear todo fluxo percorrido pelo usuário na execução da FaceRecon através de logs. Este campo aceita até 255 caracteres. | Não. |
| .setLogLevel(FaceRecognition.LogLevel logLevel) | Utilizado para customizar o nível de verbosidade dos logs da SDK. Níveis disponíveis: LogLevel.debug, LogLevel.info, LogLevel.warn, LogLevel.error e LogLevel.trace. O padrão é LogLevel.debug. | Não. |
| .setDocumentNumber(String documentNumber) | Utilizado para definir o número do documento do usuário. Este campo aceita 14 caracteres do CPF formatado da seguinte maneira 000.000.000-00 | Sim em todas as chamadas caso use a validação 1:1 em algum momento. |
| .setValidation(Boolean validation) | Utilizado para definir se a SDK deve ou não realizar a validação 1:1 com a selfie do usuário. Na primeira sessão do usuário esta flag deve estar, obrigatoriamente false. Esta função depende necessita do método setDocumentNumber preenchido. | Não. O padrão é false. |
| Parâmetro | Função | Obrigatório |
|---|
| .setOnboardingDrawable(int onboarding_drawable, int onboarding_width) | Utilizado para configurar a imagem mostrada para o usuário na tela de onboarding da SDK. O parâmetro onboarding_drawable deve referenciar o id da imagem a ser mostrada e onboarding_width é o tamanho desejado de exibição desta imagem. | Não. |
| .setButtonBorderSize(int border_size) | Utilizado para configurar a largura de borda dos botões da SDK. | Não. O padrão é 1. |
| .setButtonShadow(boolean button_shadow) | Quando setado para false remove o efeito de sombra, padrão no android, utilizado pelos botões da SDK. | Não. O padrão é true. |
O Objeto TextConfiguration
| Parâmetro | Função | Obrigatório |
|---|
| .setCustomText(CustomLabel label, String text) | Utilizado para configurar os textos mostrados para o usuário na tela de onboarding da SDK | Não. |