O que é o Identity Link
Uma verificação é um link. Você o cria, compartilha, e a pessoa o abre no navegador que já tem: nada para instalar do lado dela, nenhum SDK para publicar do seu. Dentro dessa sessão ela fotografa o documento de identidade e, no tipoFULL FLOW, faz a prova de vida. A VU lê o documento por OCR, compara o rosto ao vivo com a foto impressa nele, checa as duas capturas contra tentativas de spoofing e devolve um único resultado consolidado.
O que a pessoa nunca faz é mandar a foto do documento dela por um app de mensagens. As capturas viajam dentro da sessão do próprio link, e o registro que elas produzem vive exatamente o que duram as duas janelas de expiração configuradas na sua conta. Depois disso a API responde 410 para o registro e 404 para as imagens dele.
A API é um recurso pago. Só Premium e Pro conseguem obter um token — no Basic,
POST /oauth/token responde 401 invalid_client. A cota de verificações, as janelas de expiração, a personalização e a precisão da localização mudam conforme o plano. Veja Planos.Como funciona
1
Autenticar
Obtenha um Bearer token via OAuth2 client credentials com seu
clientId e clientSecret. Veja Autenticação.2
Criar link
Chame
POST /links para gerar um link de verificação. Escolha entre os tipos FULL FLOW (documento + prova de vida) ou ID ONLY (apenas documento).3
Compartilhar linkUrl
Envie o
linkUrl retornado ao usuário final por e-mail, WhatsApp, SMS ou QR code.4
Usuário conclui o fluxo
O usuário acessa o link, captura o documento e, se for
FULL FLOW, realiza a prova de vida.5
Receber webhook ou consultar status
Receba eventos em tempo real via webhook ou faça polling em
GET /verifications/{id}/status.6
Ler dados extraídos
Consulte
GET /verifications/{id} para obter os dados documentais extraídos, geolocalização e resultado final.Fluxo adaptativo
A partir da versão 2.2.0, um linkFULL FLOW pode ativar o fluxo adaptativo com o campo adaptiveFlow. Quando o cliente já se verificou antes, o link resolve para uma ramificação de apenas selfie e pula a captura documental. A ramificação efetiva aparece como method (FACE ou DOCUMENT) no endpoint de status.
O fluxo adaptativo precisa de externalUserId para localizar a verificação anterior. Se você não o conhece na criação do link, o usuário pode informar o e-mail durante o fluxo com PATCH /verifications/identify. Veja Links.
URL base e versão
Todas as chamadas usam a seguinte URL base:Próximos passos
Explore os guias de integração para implementar cada etapa:Autenticação
Como obter e usar o Bearer token com OAuth2 client credentials.
Links
Criar, compartilhar e gerenciar links de verificação.
KYC
Consultar status e dados documentais extraídos por OCR.
Prova de Vida
Entender o fluxo de biometria facial anti-spoofing.
Webhooks
Receber notificações em tempo real no seu servidor.
Erros
Referência de códigos HTTP e erros da API.
Precisa de informações gerais sobre a VU Security? Acesse Other Technical Docs (Wiki).