Instalação

O LivenessFacetecSDK Web é distribuído exclusivamente via CDN. Você adiciona uma única tag <script> à sua aplicação e o SDK carrega automaticamente o motor FaceTec — não é preciso adicionar uma segunda tag para o FaceTec.

Visão geral

Integração com uma tag

Carregue o SDK inteiro com uma única tag <script>

B2B by design

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

Sem ponto de montagem

A captura abre como camada full-screen sobre a página

Customização completa

Locales pt-BR/en-US e temas que espelham a API do FaceTec

Requisitos

Requisito	Descrição
HTTPS	Obrigatório em produção. A API `getUserMedia` exige contexto seguro. `localhost` é permitido para desenvolvimento.
Câmera	Câmera acessível pelo navegador.
Backend próprio	Endpoint server-side que chama `POST /api/v2/sessions` com `x-api-key`.
Domínio autorizado	Envie à equipe da Valid os domínios (produção e homologação) que vão carregar o SDK, para liberação na licença FaceTec.

Sem a liberação do domínio na licença FaceTec, a inicialização do SDK falha (veja INITIALIZATION_FAILED). Envie os domínios à equipe da Valid antes de testar em produção.

Instalação via CDN

Não há pacote npm público — o SDK é carregado diretamente do CDN.

Produção — recomendado (sempre a mais recente)

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

Produção — versão fixa

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

Variante	Cache	Quando usar
`latest`	5 minutos	Recomendado. Recebe atualizações automaticamente, sem trabalho manual de atualizar a versão
Versão fixa (`v{versão}`)	1 ano (imutável)	Se você quiser controle explícito de quando atualizar

Para descobrir a versão publicada no momento:

curl https://cdn.hub-liveness-service.app/facetec/v10/latest/manifest.json
# { "version": "2.0.0", "updated": "..." }

Verificando o carregamento

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

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

Assim que o script termina de carregar, o SDK já dispara sozinho o preload do motor FaceTec — você não precisa chamar nada manualmente para isso.

Estrutura HTML mínima

<!doctype html>
<html>
  <head>
    <script src="https://cdn.hub-liveness-service.app/facetec/v10/latest/prd/facetec-sdk.js"></script>
  </head>
  <body>
    <!-- Nenhum elemento de montagem é necessário: a captura abre como camada full-screen -->
  </body>
</html>

Backend obrigatório

O SDK não embarca a x-api-key. Você precisa expor um endpoint no seu backend que chame POST /api/v2/sessions e devolva apenas sessionId/sessionToken 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 { ssid } = req.body;

  const r = await fetch('https://api.valid.com/facetec-vendor/api/v2/sessions', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.PLATFORM_ID_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      clientRequestId: crypto.randomUUID(),
      ssid,
      platform: 'WEB',
    }),
  });

  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,
  });
});

app.listen(8080);

Próximos passos

Implementação

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

Customização

Personalize cores, textos, fontes e idioma da UI

Solução de problemas

Mapeamento de erros, causas e diagnóstico

Serviço

Contrato HTTP do backend que emite o token de sessão

Primeiros Passos

Onboarding

Bureau

Liveness

Assinatura Digital

ID Check

Card Check

TrustPass

BPO

Extração Dados

Mensageria

Documentoscopia

Storage

Coleção Postman

Visão geral

Integração com uma tag

B2B by design

Sem ponto de montagem

Customização completa

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

Sem ponto de montagem

Customização completa

​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