PassiveFaceLiveness (Descontinuado)

Importando SDK

Para usar o PassiveFaceLiveness, 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/passive-face-liveness/<VERSION>.umd.js"
  type="text/javascript"
></script>

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

const { PassiveFaceLivenessSdk } =
  window["@combateafraude/passive-face-liveness"];

Localmente

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

import { PassiveFaceLivenessSdk } from "../assets/js/passive-face-liveness-<VERSION>.js";

Construção

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

const sdk = new PassiveFaceLivenessSdk(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
environmentSettings.disableDesktopExecution Indica se a execução em desktops deve ser bloqueada.	Não. O padrão é false
environmentSettings.disableVisibilityChangeSecurity Desativa o aprimoramento de segurança responsável por fechar o SDK quando o usuário troca de aba no navegador.	Não. O padrão é false
environmentSettings.disableFaceDetectionSecurity Desativa o aprimoramento de segurança responsável por fechar o SDK quando o usuário afasta o rosto da máscara na captura automática.	Não. O padrão é false
capturerSettings.disableAdvancedCapturing Indica se a captura avançada deve ser desativada*.	Não. O padrão é false
capturerSettings.disableVideoCapturing Flag indicando se a captura de vídeo deve ser desativada*.	Não. O padrão é false
appearenceSettings.hideSwitchCameraButton ocultar o botão de trocar câmera.	Não
appearenceSettings.captureButtonIcon A personalização do ícone de captura aceita valores como URL de imagem ou base64 de SVGs.	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 base64 de SVGs.	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.isNotAliveMessage Personalização da mensagem quando o parâmetro isAlive retorna como false.	Não. O padrão é "Não conseguimos capturar seu rosto :( Por favor, tente novamente."
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 PassiveFaceLivenessSdk({
  token: `my-sdk-token`,

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

  environmentSettings: {
    disableDesktopExecution: false,
    disableVisibilityChangeSecurity: true,
    disableFaceDetectionSecurity: true,
  },

  capturerSettings: {
    disableAdvancedCapturing: true,
    disableVideoCapturing: true,
  },

  appearenceSettings: {
    captureButtonIcon: "",
    captureIconSize: "",
    captureButtonColor: "",
    switchButtonIcon: "",
    switchIconSize: "",
    switchIconColor: "",
    fontFamily: "",
  },

  textSettings: {
    title: "",
    messages: {
      processMessage: "",
      isNotAliveMessage: "",
      captureFailedMessage: "",
    },
  },
});

CaptureStage

CaptureStage permite que o cliente configure as etapas. Para isso, oferecemos o objeto CaptureStage, onde você pode definir os seguintes parâmetros:

Parâmetro
mode Modo de captura desejado. Pode ser usado manualmente ou automaticamente. Na captura manual, um botão será habilitado para que o usuário realize a 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: 0, duration: 0 },
];

---

Os objetos são definidos para cada etapa; de acordo com um exemplo, o SDK começará com a captura automática, onde haverá 3 tentativas de captura ou um limite de tempo de 60 segundos para cada tentativa. Após exceder o tempo ou as tentativas, o SDK passará automaticamente para a próxima etapa, onde a captura manual será realizada sem limites de tempo ou tentativas, para que o usuário possa fazer quantas tentativas quiser, sem limites de tempo.

Limitar tentativas do SDK

Por meio do totalAttempts parâmetro em que você pode definir o número total de tentativas para executar o SDK; ao atingir o valor limite, o SDK será encerrado automaticamente.

Exemplo de totalAttempts

await sdk.capture(sdkContainer, stages, { personData, totalAttempts: 3 });

---

Inicialização

initialize(): Promise<void>

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

Durante esse processo, o SDK inicializará suas variáveis internas e baixará os recursos necessários para sua execução.

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

[!]Inicializar o 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 suave para o usuário.

Exemplo

await sdk.initialize();

Utilização

Abertura e captura de selfies

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

O método usado para carregar o SDK na tela e realizar a captura de selfie.

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

Parâmetros

Parâmetro	Tipo
personData.cpf Esta variável foi descontinuada, use personId	string
personData.name Nome do usuário que está realizando a autenticação (opcional).	string
personData.personId Número de documento usado como identificador único para cada usuário (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 = { personId: "user-identifier", 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
imageUrl	string	Link temporário para a imagem, gerado pela nossa API
imageKey	string	Chave do objeto
blob	Blob	Blob da imagem capturada

Exemplo

const result = await sdk.capture(sdkContainer, stages, {
  personData,
  totalAttempts,
});
// { imageUrl: '[link da imagem]', imageKey: '[chave da imagem]', blob: Blob

---

Fechar o SDK

close(): Promise<void>

O método usado para remover o SDK do canvas, removendo os elementos visuais do SDK do DOM.

Desinicializar o SDK

dispose(): Promise<void>

Método usado para remover o SDK da tela.

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

Exemplo completo

Em breve.