Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

FaceAuthenticator (Descontinuado)

Face match com prova de vida do usuário do seu app, ideal para fluxos de login ou transações financeiras valiosas.

Tamanho do SDK

Um máximo de cerca de 3,8 MB, que pode diminuir devido a estes elementos.

Analytics

Nossos SDKs, por padrão coletam informações sobre o usuário e o ambiente de execução para mapear melhor os fraudadores e entender seus comportamentos. Recomendamos manter essa coleta ativa, pois a única finalidade desses dados é reduzir fraudes, mas, se desejar, você pode desativá-la em .setAnalyticsSettings(boolean useAnalytics) parâmetro.

Permissões em tempo de execução

Permissão
Motivo
Obrigatório

CAMERA

Para capturar a selfie do usuário

Sim

Instanciando o SDK

Primeiro, crie um objeto do tipo FaceAuthenticator. Este objeto serve para configurar todas as regras de negócio do SDK:

FaceAuthenticator mFaceAuthenticator = new FaceAuthenticator.Builder(String mobileToken)
    // veja a tabela abaixo
    .build();

Todos os parâmetros anotados com @Nullable podem receber null como valor, o que é útil se você quiser definir apenas um dos parâmetros de um único método.

Método do Builder

Parâmetro
Obrigatório

String mobileToken

Token de uso associado à sua conta CAF.

Sim.

.setPeopleId(String peopleId)

Identificador do usuário para realizar o facematch. Atualmente, este valor aceita apenas o CPF do usuário.

Sim.

.setAnalyticsSettings(boolean useAnalytics)

Ativa/desativa a coleta de dados para analytics.

Não, o padrão é true

.setStabilitySensorSettings(@Nullable SensorStabilitySettings sensorStabilitySettings)

Altera as configurações padrão do sensor de estabilidade. Aplique null se você não quiser usar este sensor.

Não. O tempo padrão é 1000 ms e o limiar padrão é 0,7 m/s².

.setCaptureSettings(@Nullable CaptureSettings captureSettings)

Define as configurações de captura. O método aceita instâncias da ImageCapture e VideoCapture classes.

Não. O padrão é ImageCapture

.setLayout(@Nullable @LayoutRes Integer layoutId)

Substitui o layout padrão do SDK. Crie um arquivo na pasta layout do seu projeto, copie este modelo e faça as alterações desejadas.

Não. O padrão é este

.setMask(@DrawableRes Integer greenMask, @DrawableRes Integer whiteMask, @DrawableRes Integer redMask)

Altera as máscaras de captura facial: SUCCESS, NORMAL e FAIL, nessa ordem. Se você usar esta opção, use máscaras com a mesma área de detecção que o rosto, esta região é muito importante para o algoritmo capturar.

Não. Os padrões de máscara são:

Normal

Sucesso

Falha

.setStyle(@StyleRes int styleResourceId)

Substitui o estilo padrão do SDK. No styles.xml arquivo do seu projeto, copie este modelo e edite-o.

Não. O padrão é este

.enableSwitchCameraButton(boolean enable)

Ativa/desativa o botão para o usuário alternar entre a câmera frontal e a traseira.

Não. O padrão é true

.setNetworkSettings(int requestTimeout)

Define o tempo limite intervalo para solicitações do SDK.

Não. O padrão é 60 (segundos)

.enableGoogleServices(boolean enable)

Permite ativar/desativar recursos do SDK que consomem GoogleServices; não recomendamos desativar os serviços devido à perda de segurança.

Não. O padrão é true

.setUseEmulator(boolean use)

Permite o uso de emuladores quando true. Quando true, o modo ADB também é ativado para que o emulador funcione corretamente. Não é recomendado ativar esta opção; use-a apenas para fins de teste.

Não. O padrão é false

.setUseRoot(boolean use)

Permite o uso de dispositivos com root quando true.

Não. O padrão é false

.setUseDeveloperMode(boolean use)

Permite o uso do modo desenvolvedor quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.

Não. O padrão é false

.setUseAdb(boolean use)

Ativa o modo de depuração Android Debug Bridge (ADB) quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.

Não. O padrão é false

.setUseDebug(boolean use)

Permite usar o app em modo de depuração quando true. Não é recomendado ativar esta opção; use-a apenas para fins de teste.

Não. O padrão é false

.setAudioSettings(boolean use)

Ativa/desativa a reprodução dos áudios do SDK.

Não. O padrão é true

.setAudioSettings(Integer audioResId)

Permite personalizar o áudio usado pelo SDK.

Não. O padrão é "Registro Facial".

.enableBrightnessIncrease(boolean enable)

Ativa/desativa o aumento do brilho do dispositivo ao abrir o SDK.

Não. O padrão é true

.setEyesClosedSettings(boolean enable, double threshold)

Permite personalizar as configurações de validação de olhos abertos do SDK. O método espera como parâmetro enable para ativar ou desativar a validação, e threshold, valor entre 0,0 e 1,0Permite personalizar as configurações de validação de olhos abertos do SDK. O método espera como parâmetro enable para ativar ou desativar a validação, e threshold, valor entre 0,0 e 1,0

Não. O padrão é true e 0.5

.setStage(CafStage stage)

Permite escolher o ambiente em que o SDK será executado (produção, beta). O método recebe como parâmetro um enum CafStage para selecionar o ambiente:

Não. O padrão é CafStage.PROD

Enum

Descrição

CafStage.PROD

Usará o ambiente de produção da Trust Platform para registrar as execuções do SDK.

CafStage.BETA

Usará o ambiente de beta da Trust Platform para registrar as execuções do SDK.

Cada ambiente (beta e produção) exige seu próprio mobileToken específico, gerado na plataforma Trust do respectivo ambiente.

Validações de segurança

Estamos constantemente tomando ações para tornar o produto cada vez mais seguro, mitigando uma série de ataques observados no processo de captura e, consequentemente, reduzindo ao máximo possível as fraudes de identidade. O SDK possui alguns bloqueios que podem impedir sua execução em determinados contextos. Para desativá-los, você pode usar os métodos conforme mostrado no exemplo abaixo:

Desativar as validações de segurança é recomendado apenas para fins de teste. Para publicar seu aplicativo em produção, recomendamos usar as configurações padrão.

Iniciando a Activity

Depois de criar o FaceAuthenticator, inicie o FaceAuthenticatorActivity passando esse objeto como parâmetro via extra intent:

Obtendo o resultado

Para obter o FaceAuthenticatorResult objeto, que contém as capturas realizadas pelo SDK, sobrescreva o onActivityResult método na mesma activity em que você iniciou o FaceAuthenticatorActivity:

FaceAuthenticatorResult

Parâmetro
Permite null

boolean authenticated

Sinalizador que indica se a selfie capturada passou no facematch com a foto armazenada no servidor da CAF e o respectivo CPF inserido pelo usuário.

Não

String signedResponse

Resposta assinada do servidor da CAF que realizou o facematch. Use este parâmetro se quiser uma camada extra de segurança, verificando se a assinatura da resposta não foi adulterada ou causada por uma solicitação interceptada. Se estiver adulterada, há uma forte indicação de interceptação da solicitação.

Sim, em caso de erro

String trackingId

Identificador desta execução em nossos servidores. Se possível, salve este campo e envie-o para a nossa API. Assim teremos mais dados sobre como o usuário se comportou durante a execução.

Sim, se o usuário definir useAnalytics = false ou as chamadas de analytics não funcionarem

SDKFailure sdkFailure

Objeto que informa o motivo do encerramento do SDK. Para mais informações, veja aqui.

Sim, em caso de sucesso

lensFacing: Int

Define o lado da câmera que foi usado. Use FaceAuthenticatorResult.LENS_FACING_FRONT ou FaceAuthenticatorResult.LENS_FACING_FRONT para validar.

Não

Atualizado