Quickstart

Instale o @legitimuz/websdk e abra o primeiro fluxo de verificação na sua página.

Ao final deste guia, o fluxo de verificação abre dentro da sua página e os eventos da sessão chegam ao seu código.

Pré-requisitos

• Uma sdkUrl válida. Ela identifica uma verificação, é emitida pelo servidor da Legitimuz e vale por tempo limitado. Trate-a como credencial.
• Node.js 18 ou superior e npm, se for instalar via pacote.

Abra o primeiro fluxo

1. Instale o Web SDK

   npm

   npm install @legitimuz/websdk
   

   Pelo CDN, o SDK fica disponível como window.Legitimuz, com a mesma API do pacote npm.

2. Reserve o container

   O widget renderiza dentro de um elemento seu e ocupa 100% da altura dele. Sem altura, o widget existe na página e não aparece.

   <div id="verificacao" style="height: 640px"></div>
   
3. Monte o fluxo

   import { mount } from "@legitimuz/websdk";
   
   const handle = mount({
     sdkUrl: "<SUA_SDK_URL>",
     target: document.querySelector("#verificacao"),
     onReady: () => {
       // o widget carregou e a primeira tela está visível
     },
     onComplete: (result) => {
       // o fluxo terminou; cheque result.status antes de tratar como sucesso
     },
     onError: (error) => {
       // erros chegam aqui, nunca como exceção
     },
   });
   

   mount() retorna um handle com destroy() e a promise ready. Chame handle.destroy() ao remover o widget da página.

4. Confira que funcionou

   A tela de boas-vindas aparece dentro do container e o onReady dispara. Se nada aparecer em 15 segundos, o onError recebe o código 6005; as causas comuns estão logo abaixo.

Quando não funciona

Nada aparece e o onError recebe 6005

O widget não sinalizou ready dentro do tempo limite. As causas mais comuns:

• a origem da sua página não está na allowlist da integração (o navegador recusa o iframe sem avisar o host);
• a sdkUrl expirou ou está inacessível.

O campo context.likelyCauses do erro lista as hipóteses. Veja tratamento de erros.

O onError recebe 6003 ou 6004

Falta sdkUrl ou target (6003), ou a sdkUrl não é a URL absoluta esperada (6004). O campo context.param do erro aponta qual opção corrigir.

Próximos passos

Usar com React

O hook useLegitimuz e o componente LegitimuzWidget.

Opções do mount()

Aparência, idioma, timeout e todos os callbacks.