FaceAuthenticator (Descontinuado)

Importando SDK

Para usar o FaceAuthenticator, você pode importar remotamente o .js arquivo ou baixá-lo localmente.

Remotamente

Inclua o .js arquivo diretamente da CDN:

<script src="https://repo.combateafraude.com/javascript/release/face-authenticator-deprecated/<VERSION>.umd.js" type="text/javascript"></script>

Você pode obter a classe do SDK usando o seguinte código:

const { FaceAuthenticatorSdk } = window['@combateafraude/face-authenticator'];

Localmente

Baixe o .js arquivo e importe-o como um módulo ES6:

import { FaceAuthenticatorSdk } from '../assets/js/face-authenticator-<VERSION>.js'

Construção

No construtor, o SDK recebe um único parâmetro com as configurações:

const sdk = new DocumentDetectorSdk(options);

Parâmetros suportados

Parâmetro	Obrigatório?
token Token de autenticação para consumir o SDK.	Sim.
language Idioma padrão das mensagens, valores válidos: en_US, en_BR, es_MX.	Não. O padrão é pt_BR
analyticsSettings Objetos de configuração de análise.	Não.
analyticsSettings.disableAnalytics Parâmetro responsável por habilitar ou desabilitar a análise.	Não.
analyticsSettings.trackingId ID único no qual vamos salvar as informações desta execução do SDK.	Não.
analyticsSettings.trackingInfo Aceitamos um objeto de informações.	Não.
environmentSettings.disableDesktopExecution Indica se a execução em desktops deve ser bloqueada.	Não. O padrão é false
capturerSettings.disableAdvancedCapturing Indica se a captura avançada deve ser desativada*.	Não. O padrão é false
appearenceSettings.captureButtonIcon A personalização do ícone de captura aceita valores como URL de imagem ou SVGs em base64.	Não
appearenceSettings.captureIconSize Personalização do tamanho do ícone para o campo captureButtonIcon.	Não
appearenceSettings.captureButtonColor Personalização da cor padrão do botão de captura de imagem.	Não
appearenceSettings.switchButtonIcon A personalização do ícone de troca de câmera aceita valores como URL de imagem ou SVGs em base64.	Não
appearenceSettings.switchIconSize Personalização do tamanho do ícone para o campo switchButtonIcon.	Não
appearenceSettings.switchIconColor Personalização da cor do ícone padrão de troca de câmera.	Não
appearenceSettings.fontFamily Altera a fonte de todos os elementos contidos no SDK.	Não. O padrão é herdado da página
textSettings.messages.processMessage Personalização da mensagem de processamento da imagem.	Não. O padrão é "Processando sua foto, aguarde um momento"
textSettings.messages.captureFailedMessage Personalização da mensagem de falha na captura.	Não. O padrão é "Ops! Tivemos um problema ao processar sua imagem."

* A captura avançada consiste em usar APIs mais complexas e não tão estáveis nos navegadores que oferecem suporte a elas (por exemplo, ImageCapture)

Exemplo

const sdk = new DocumentDetectorSdk({
    token: `my-sdk-token`,
    language: `pt_BR`,

    analyticsSettings: {
      disableAnalytics: false,
      trackingId: "",
      trackingInfo: "",
    },

    environmentSettings: {
        disableDesktopExecution: false,
    },


    appearenceSettings: {
        hideCaptureTitle: false,
        hideCaptureMask: false,
        hideCameraSwitchButton: false,
        useGenericMask: false,
    },

    capturerSettings: {
        disableAdvancedCapturing: false,
    },

    textSettings: {
        messages: {
            processMessage: '',
            wrongDocumentMessage: '',
            bothWrongSideMessage: '',
            wrongSideMessage: '',
            lowQualityMessage: '',
            captureFailedMessage: '',
        }
});

CaptureStage

CaptureStage permite ao cliente configurar os estágios. Para isso, oferecemos o CaptureStage objeto, no qual você pode definir os seguintes parâmetros:

Parâmetro
mode Modo de captura desejado. Pode ser usado manual, automático ou envio. Na captura manual, um botão será habilitado para o usuário fazer a captura; no envio, a funcionalidade de envio de documentos será exibida em vez da captura.
tentativas O número de tentativas do estágio atual. Se for o único estágio, o valor 0 deve ser passado.
duração Tempo de duração do estágio atual. Se houver mais de um estágio definido, é possível definir o tempo total de cada estágio e, quando o tempo total for atingido, o estágio avançará para o próximo. Defina como 0 se você não quiser definir um tempo para o estágio.

Exemplo de CaptureStage

const stages = [
  { mode: "automatic", attempts: 3, duration: 60 },
  { mode: "manual", attempts: 3, duration: 60 },
  { mode: "upload", attempts: 0, duration: 0 },
];

Inicialização

initialize(): Promise<void>

O SDK possui um método separado de inicialização, para permitir maior controle sobre quando ela ocorre.

Durante essa inicialização, o SDK inicializará suas variáveis internas e baixará os recursos necessários para executar.

[!] Você deve chamar este método antes de usar outros métodos do SDK.

[!] A inicialização do SDK pode levar alguns segundos. Recomendamos que você chame essa função o mais cedo possível no seu fluxo para que a abertura do SDK seja tranquila para o usuário.

Exemplo

await sdk.initialize();

Utilização

Abertura e captura de selfies

capture(container: HTMLElement, stages, {personData?: PersonData, totalAttempts?: Number}): Promise<Result>

Método usado para carregar o SDK na tela e realizar a captura da selfie.

Ele inicializará o stream (solicitando permissões, se necessário) e o carregará no contêiner.

Parâmetros

Parâmetro	Tipo
personData.cpf CPF do usuário que está realizando a autenticação (obrigatório).	string
personData.name Nome do usuário que está realizando a autenticação (opcional).	string

¹ Se não for especificado, a captura automática será usada.

² Se não for especificado, é usado o valor padrão de 30 segundos.

Exemplo

// div ou outro elemento no DOM
const sdkContainer = document.getElementById('sdk-displayer');
const personData = { cpf: 'user-cpf', name: 'user-name' };
await sdk.capture(sdkContainer, stages, {personData, totalAttempts});

Retornar

O retorno consiste em um objeto com os seguintes campos:

Campo	Tipo	Descrição
requestId	string	Identificador único da requisição
isMatch	booleano	Booleano indicando se o rosto capturado é idêntico ao rosto registrado para o informado peopleId
peopleId	string	Informações do documento informadas para autenticação
openEyesProbability	número	Probabilidade de os olhos estarem abertos na selfie capturada

Fechar o SDK

close(): Promise<void>

Método usado para remover o SDK da tela.

Desinicializar o SDK

dispose(): Promise<void>

Método usado para remover o SDK da tela.

Desinicializará o fluxo de vídeo e limpará as variáveis internas do SDK

Exemplo completo

Em breve.