> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vu-one.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Identity Link API: Guia de Integração Completo

> Aprenda como integrar o VU Identity Link para verificar identidades digitais com biometria e captura documental em minutos.

O VU Identity Link é uma API que permite criar links de verificação de identidade de uso único. Você compartilha o link com o usuário final, que realiza a captura documental e, opcionalmente, a prova de vida diretamente pelo navegador. Depois, você consulta os dados extraídos por OCR e os resultados biométricos.

Use este guia para entender o fluxo completo, desde a autenticação até a leitura dos resultados KYC.

## 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 tipo `FULL 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.

<Note>
  **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](/pt/identity-link/planos).
</Note>

## Como funciona

<Steps>
  <Step title="Autenticar">
    Obtenha um Bearer token via OAuth2 client credentials com seu `clientId` e `clientSecret`. Veja [Autenticação](/pt/identity-link/autenticacao).
  </Step>

  <Step title="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).
  </Step>

  <Step title="Compartilhar linkUrl">
    Envie o `linkUrl` retornado ao usuário final por e-mail, WhatsApp, SMS ou QR code.
  </Step>

  <Step title="Usuário conclui o fluxo">
    O usuário acessa o link, captura o documento e, se for `FULL FLOW`, realiza a prova de vida.
  </Step>

  <Step title="Receber webhook ou consultar status">
    Receba eventos em tempo real via webhook ou faça polling em `GET /verifications/{id}/status`.
  </Step>

  <Step title="Ler dados extraídos">
    Consulte `GET /verifications/{id}` para obter os dados documentais extraídos, geolocalização e resultado final.
  </Step>
</Steps>

## Fluxo adaptativo

A partir da versão 2.2.0, um link `FULL 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](/pt/identity-link/links#fluxo-adaptativo).

## URL base e versão

Todas as chamadas usam a seguinte URL base:

```text theme={null}
https://api.identity.vu-one.com/api/v1
```

A versão estável atual é **v2.3.2**. As mudanças de comportamento são anunciadas no [changelog](/pt/identity-link/changelog).

## Próximos passos

Explore os guias de integração para implementar cada etapa:

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/pt/identity-link/autenticacao">
    Como obter e usar o Bearer token com OAuth2 client credentials.
  </Card>

  <Card title="Links" icon="link" href="/pt/identity-link/links">
    Criar, compartilhar e gerenciar links de verificação.
  </Card>

  <Card title="KYC" icon="id-card" href="/pt/identity-link/kyc">
    Consultar status e dados documentais extraídos por OCR.
  </Card>

  <Card title="Prova de Vida" icon="face-viewfinder" href="/pt/identity-link/prova-de-vida">
    Entender o fluxo de biometria facial anti-spoofing.
  </Card>

  <Card title="Webhooks" icon="bell" href="/pt/identity-link/webhooks">
    Receber notificações em tempo real no seu servidor.
  </Card>

  <Card title="Erros" icon="triangle-exclamation" href="/pt/identity-link/erros">
    Referência de códigos HTTP e erros da API.
  </Card>
</CardGroup>

<Note>
  Precisa de informações gerais sobre a VU Security? Acesse [Other Technical Docs (Wiki)](https://wiki.corp.vusecurity.com/es/home).
</Note>


## Related topics

- [Códigos de Erro e Respostas da Identity Link API](/pt/identity-link/erros.md)
- [Guia de integração](/pt/vucs/face-analysis/integracao.md)
- [Changelog da Identity Link API](/pt/identity-link/changelog.md)
- [Documentação técnica da VU](/pt/index.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.