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

# Apresentação

> Use o motor IDENTY Face AI diretamente em sua aplicação através do LivenessIdentySDK

Esta sessão documenta a integração de **liveness usando o motor IDENTY Face AI diretamente**, distribuído pela Valid através do **`LivenessIdentySDK`** — um SDK que embute o IDENTY Face AI SDK e orquestra a sessão biométrica fim-a-fim contra o backend da Plataforma ID.

## Quando usar essa rota

A Plataforma ID oferece duas formas de integrar liveness:

| Característica | Liveness Hub | Identy direto |
| - | - | - |
| Motor biométrico | Abstraído | IDENTY Face AI (fixo) |
| Pacote no cliente | `liveness-hub-sdk` | `liveness-identy-sdk` (Android) / `LivenessIdentySDK` (iOS e Web) |
| Customização | Padronizada Valid | Limitada às opções expostas pelo `LivenessIdentySDK` |
| Quando escolher | Caso de uso geral, integração mais simples | Requisito contratual de IDENTY |

Se você não tem um requisito específico que demande o motor IDENTY, prefira o [**Liveness Hub**](https://docs-platform.services-valid.com.br/plataforma/liveness/hub/sdk/android/installation.md) (também disponível para iOS).

## Plataformas suportadas

> [!NOTE]
>
> O `LivenessIdentySDK` está disponível para **Android, iOS e Web**.

| Plataforma | Status | Versão |
| - | - | - |
| Android | Disponível | `liveness-identy-sdk 1.0.0` (IDENTY Face AI `7.1.6`) |
| iOS | Disponível | `LivenessIdentySDK 1.0.0` (IDENTY Face AI `7.1.2`) |
| Web | Disponível | `LivenessIdentySDK 1.0.0` via CDN |

## Como funciona

O `LivenessIdentySDK` expõe uma fachada minimalista que, internamente:

1. Inicializa o IDENTY Face AI SDK com os parâmetros fornecidos pelo consumer.
2. Coleta a assinatura de dispositivo da Shield (Cashshield), usada pelo seu backend na criação da sessão.
3. Abre a UI nativa do IDENTY Face AI e captura o face scan.
4. Submete o resultado ao backend de forma segura.
5. Emite o resultado consolidado para a aplicação.

Você não precisa lidar manualmente com a submissão do resultado — essa orquestração está dentro do SDK. A criação da sessão (obter o `sessionToken` junto ao seu backend) continua sendo responsabilidade do seu app — veja [Serviço](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/servico.md).

No Web, o SDK pede a sessão chamando o callback `onInit` que você implementa, já repassando o `ssid` da Shield — veja [Implementação Web](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/web/implementacao.md).

## Próximos passos

### Android

> **[Instalação](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/android/instalacao.md)**
>
> Adicione o binário e configure o seu projeto

> **[Implementação](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/android/implementacao.md)**
>
> Inicialize o SDK e dispare uma verificação de vivacidade

> **[Customização](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/android/customizacao.md)**
>
> Personalize a aparência da UI do IDENTY Face AI

> **[Solução de problemas](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/android/troubleshooting.md)**
>
> Erros comuns, mapeamento de exceções e dicas de ProGuard

### iOS

> **[Instalação](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/ios/instalacao.md)**
>
> Adicione o XCFramework e configure o Xcode

> **[Implementação](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/ios/implementacao.md)**
>
> Inicialize o SDK e dispare uma verificação de vivacidade

> **[Customização](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/ios/customizacao.md)**
>
> Veja o estado atual das opções de personalização de UI

> **[Solução de problemas](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/ios/troubleshooting.md)**
>
> Erros comuns, re-assinatura de frameworks e limitação do simulador

### Web

> **[Instalação](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/web/instalacao.md)**
>
> Carregue o SDK via CDN e autorize as suas origens

> **[Implementação](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/web/implementacao.md)**
>
> Crie a sessão e dispare uma verificação com `run()`

> **[Customização](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/web/customizacao.md)**
>
> Idioma, segurança, captura e visual da tela

> **[Solução de problemas](https://docs-platform.services-valid.com.br/plataforma/liveness/identy/sdk/web/troubleshooting.md)**
>
> Erros, motivos de reprovação e CSP


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