SDKs
O SDK de verificação de identidade e o caminho sem SDK.
A maioria das integrações não precisa de SDK — a página hospedada faz o trabalho. O widget web está disponível quando você quer que o fluxo permaneça dentro da sua própria página. Os SDKs móveis nativos são os próximos.
O caminho sem SDK
A página hospedada não precisa de SDK, em nenhuma plataforma.
POST /v1/sessions retorna uma verification_url. Envie-a ao solicitante da forma que o seu produto já envia links — e-mail, SMS, redirecionamento dentro do app, um QR code em uma tela — e o ShieldID cuida da captura, do desafio de prova de vida e da selfie no celular dele.
- Funciona a partir de um app web, do navegador do sistema ou WebView de um app nativo, de um link por e-mail ou de um QR code em quiosque — nada para instalar
- Marca própria (white-label) em planos elegíveis, para que não pareça um redirecionamento a terceiros
- Os resultados chegam até você pelo redirecionamento da return_url e pelo webhook assinado — sem necessidade de configurar callbacks no cliente
O widget web
Incorpore o fluxo na sua própria página.
Um pequeno script que renderiza o fluxo de verificação hospedado dentro de um iframe na sua página, em vez de enviar o solicitante para fora dela.
O que funciona hoje
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) cria uma sessão e a monta em um elemento da sua escolha
- Executa o mesmo fluxo de captura da página hospedada, dentro do seu layout, com o seu accentColor e logotipo
- Funciona hoje para criar uma sessão e exibir o fluxo inline
Callbacks de conclusão
Em breveonComplete, onCancel, onStep e o redimensionamento automático do iframe fazem parte da interface do widget, mas nada dentro do fluxo os aciona ainda. Não construa uma lógica que dependa do disparo deles — use a URL de retorno e o webhook, que já funcionam hoje.
Uma observação sobre chaves de API no navegador
A chamada init() do próprio widget está documentada como capaz de aceitar uma apiKey em texto puro em JavaScript do lado do cliente. Não recomendamos isso em produção: qualquer pessoa que visualizar o código-fonte obtém a sua chave. Em vez disso, crie a sessão no seu backend com POST /v1/sessions e passe ao widget a verification_url resultante para exibição — a mesma recomendação do fluxo hospedado, só que incorporado em vez de acessado por link.
<div id="shieldid-verify"></div>
<!-- Exact script URL is published with your API keys; the path below is illustrative. -->
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<script>
// Recommended: create the session on your backend first (see API reference),
// then pass its verification_url straight through — never a raw API key.
TLVerify.init({
containerId: "shieldid-verify",
verificationUrl: "{{ session.verification_url }}", // from your backend
theme: { accentColor: "#0B5CD8" },
});
</script>Mobile
SDKs nativos estão a caminho.
Hoje não existe SDK para iOS ou Android. Até que exista, abra a página de verificação hospedada no navegador do sistema do seu app ou em uma WebView — é o mesmo fluxo que um solicitante na web recebe, e funciona agora, em qualquer plataforma em que seu app rode.
Em breveSDKs nativos para iOS e Android
Escolhendo um caminho
Três formas de começar, comparadas com honestidade.
Comece pela página hospedada, a menos que você tenha um motivo específico para incorporar.
| Recurso | Página hospedada | Widget web | SDK mobile |
|---|---|---|---|
| Sem SDK, sem código do lado do cliente | Sim | Não | Em breve |
| Permanece dentro da sua própria página | Abre como um link | iframe incorporado | Em breve |
| Callbacks de conclusão no seu código | URL de retorno + webhook | Em breve | Em breve |
| Sua marca | Em planos elegíveis | Em planos elegíveis | Em breve |
| Funciona hoje | Sim | Sim | Não |
Perguntas
Perguntas frequentes sobre o SDK e o widget.
Comece a construir
A página hospedada é o caminho mais rápido.
Uma chamada de API, um link, sem necessidade de SDK. Experimente hoje com uma chave sandbox.