Instalação

O LivenessFacetecSDK Web é distribuído exclusivamente via CDN. Você adiciona uma única tag <script> à sua aplicação e o SDK injeta dinamicamente o FaceTecSDK.js da FaceTec a partir de um bucket público hospedado pela Valid.

Visão geral

Integração com uma tag

Carregue o SDK pelo CDN

B2B by design

A x-api-key nunca toca o navegador — vive no seu backend

Customização completa

Locales pt-BR/en-US, paleta de cores e textos editáveis

HMAC automático

Assinatura HMAC-SHA256 das capturas é feita pelo SDK

Requisitos

Requisito	Descrição
HTTPS	Obrigatório em produção. A API `getUserMedia` exige contexto seguro. `localhost` é permitido para desenvolvimento.
Navegadores	Chrome 60+, Firefox 55+, Safari 14.1+, Edge 79+. Necessita `WebCrypto`, `fetch` e `getUserMedia`.
Câmera	Câmera acessível pelo navegador.
Backend próprio	Endpoint server-side que chama `POST /api/v1/sessions` com `x-api-key`.

Instalação via CDN

O SDK é distribuído exclusivamente via CDN. Não há pacote npm público.

Versão produção

<script src="https://cdn.hub-liveness-service.app/facetec/latest/prd/facetec-sdk.js"></script>

Verificando o carregamento

Depois do carregamento, o objeto LivenessFacetecSDK está disponível globalmente:

if (typeof window.LivenessFacetecSDK !== 'undefined') {
  console.log('LivenessFacetecSDK carregado:', window.LivenessFacetecSDK.SDK_VERSION);
} else {
  console.error('Falha ao carregar o SDK');
}

Estrutura HTML mínima

<!doctype html>
<html>
  <head>
    <script src="https://cdn.hub-liveness-service.app/facetec/latest/prd/facetec-sdk.js"></script>
  </head>
  <body>
    <div id="camera-container""></div>
  </body>
</html>

O elemento #camera-container é onde o SDK renderiza a UI do FaceTec.

Backend obrigatório

O SDK não embarca a x-api-key. Você precisa expor um endpoint no seu backend que chame POST /api/v1/sessions na Plataforma ID e devolva apenas os tokens de sessão ao cliente.

Nunca exponha a x-api-key no navegador. Mesmo ofuscada, qualquer chave embarcada no bundle JS pode ser extraída por DevTools. Veja Serviço para o fluxo recomendado.

Exemplo mínimo (Node.js / Express):

import crypto from 'node:crypto';
import express from 'express';

const app = express();
app.use(express.json());

app.post('/api/create-session', async (req, res) => {
  const { visitorId, eventId, maxAttempts } = req.body;

  const r = await fetch('https://facetec.hub-liveness-service.app/api/v1/sessions', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.PLATFORM_ID_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      clientRequestId: crypto.randomUUID(),
      visitorId,
      eventId,
      maxAttempts, // opcional — número máximo de capturas na sessão (1–5, default 3)
    }),
  });

  if (!r.ok) return res.status(r.status).json(await r.json());

  const session = await r.json();
  res.json({
    sessionId: session.sessionId,
    sessionToken: session.sessionToken,
    facetecSessionToken: session.facetecSessionToken,
  });
});

app.listen(8080);

Próximos passos

Implementação

Inicialize o SDK e dispare uma verificação de liveness

Customização

Personalize cores, textos e idioma da UI

Solução de problemas

Hierarquia de erros e diagnóstico

Serviço

Contrato HTTP do backend que emite os tokens

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

BPO

Extração Dados

Mensageria

Documentoscopia

Visão geral

Integração com uma tag

B2B by design

Customização completa

HMAC automático

Requisitos

Instalação via CDN

Verificando o carregamento

Estrutura HTML mínima

Backend obrigatório

Próximos passos

Implementação

Customização

Solução de problemas

Serviço

​Visão geral

Integração com uma tag

B2B by design

Customização completa

HMAC automático

​Requisitos

​Instalação via CDN

​Verificando o carregamento

​Estrutura HTML mínima

​Backend obrigatório

​Próximos passos

Implementação

Customização

Solução de problemas

Serviço

Visão geral

Requisitos

Instalação via CDN

Verificando o carregamento

Estrutura HTML mínima

Backend obrigatório

Próximos passos