> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-sdk/caf-sdk-pt-br/flutter/face-liveness.md).

# Face Liveness

Instale e inicie o Face Liveness para Flutter. Aprenda sobre os pré-requisitos, opções de CerttaLivenessConfiguration, fluxos de eventos, resultados de sucesso e falha e tratamento de erros.

{% hint style="warning" %}
Este guia aborda **caf\_sdk 2.4.0** e superiores (Certta DevX). Para a versão anterior `CafSdk` fluxo sequencial, consulte a [documentação legada](https://docs.caf.io/caf-sdk/flutter/getting-started-with-the-sdk).
{% endhint %}

## Pré-requisitos

Antes de prosseguir, certifique-se de que o Certta SDK esteja instalado corretamente. Se você ainda não fez isso, consulte nosso Guia de Instalação.

{% content-ref url="/pages/d82530ac6e7f99d44e236a0f308e73c6cf5d0223" %}
[Guia de Instalação](/caf-sdk/caf-sdk-pt-br/flutter/installation-guide.md)
{% endcontent-ref %}

Ative `faceLiveness` (e `faceLivenessUI` se quiser a interface integrada) em `caf-modules-config.json`. Você deve incluir pelo menos um provedor de liveness.

## Iniciando o Liveness

Para iniciar o fluxo de Liveness, chame `certta.liveness.open()` e passe um `CerttaLivenessConfiguration` objeto. Assine a `eventStream` **antes** de chamar `open()` para não perder resultados.

{% hint style="info" %}
Defina `useFaceLivenessUi` para `true` para usar a interface integrada da Certta. Quando `false`, o SDK executa o módulo Face Liveness sem interface.
{% endhint %}

```dart
import 'dart:async';
import 'package:flutter/services.dart';
import 'package:caf_sdk/certta_sdk.dart';

final certta = CerttaSdk();

late final StreamSubscription<CerttaLivenessEvent> _livenessSub;

void listenToLiveness() {
  _livenessSub = certta.liveness.eventStream.listen((event) {
    if (event.success != null) {
      // Trate o sucesso — event.success!.response é um JWT
    } else if (event.failed != null) {
      // Trate a falha de negócio — veja Tratando falhas
    } else if (event.error != null) {
      // Trate o erro técnico
    }
  });
}

Future<void> startLiveness() async {
  try {
    await certta.liveness.open(
      const CerttaLivenessConfiguration(
        maxRetryAttempts: 3,
        faceAuthEnabled: false,
        showLoading: true,
        useFaceLivenessUi: true,
      ),
    );
  } on PlatformException catch (e) {
    // Trate BRIDGE_EXCEPTION
  }
}
```

`open()` lança uma `PlatformException` com o código `BRIDGE_EXCEPTION` quando o mapeador nativo rejeita a configuração.

### `CerttaLivenessConfiguration` parâmetros

| Parâmetro           | Padrão  | Descrição                                                                      |
| ------------------- | ------- | ------------------------------------------------------------------------------ |
| `maxRetryAttempts`  | `3`     | Número máximo de tentativas após uma captura malsucedida.                      |
| `faceAuthEnabled`   | `false` | Quando **ativado**, o SDK realiza **autenticação facial**.                     |
| `showLoading`       | `true`  | Exibe indicadores de carregamento durante o processamento quando **true**.     |
| `useFaceLivenessUi` | `false` | Se **ativado**, o SDK usa a interface integrada do Certta Face Liveness.       |
| `payFaceDebugMode`  | `false` | Ativa o modo de depuração para o provedor PayFace (Fortface). **Somente iOS**. |

## Entendendo eventos e resultados do Liveness

{% hint style="warning" %}
Garanta que a resposta JWT seja avaliada no backend. Esse processo deve incluir a validação da assinatura do token e a verificação dos `estáVivo` e `éCorrespondente` campos. Não realize essas validações no lado do cliente.
{% endhint %}

`CerttaLivenessEvent` tem exatamente um campo preenchido:

### `success` (`CerttaSuccess`)

A captura e o pipeline de liveness foram concluídos com sucesso. **`response`** é um JWT com os dados de resultado da execução de Liveness (por exemplo, imagens capturadas ou resultados de validação).

### `failed` (`CerttaLivenessFailure`)

O Liveness foi executado, mas o resultado foi uma falha de negócio.

| Campo       | Descrição                                                                                                                |
| ----------- | ------------------------------------------------------------------------------------------------------------------------ |
| `tipo`      | Modelo de falha: `ImageCaptureFailure` ou `FaceRecognitionFailure`.                                                      |
| `causa`     | Identificador para diagnósticos ou mensagens de UX (por exemplo `TOO_DARK`).                                             |
| `descrição` | Descrição opcional legível por humanos do SDK nativo.                                                                    |
| `response`  | Payload assinado. Presente para `FaceRecognitionFailure` quando a captura foi bem-sucedida, mas o reconhecimento falhou. |

1. **`ImageCaptureFailure`:** problemas durante a captura (ambiente, tempo limite, ausência de rosto, falha específica do provedor). Normalmente não há um `response`.
2. **`FaceRecognitionFailure`:** a captura foi bem-sucedida, mas o reconhecimento facial / backend não aceitou o resultado.

{% hint style="info" %}
Para entender e tratar o `causa` da falha, veja [Tratando falhas](/caf-sdk/caf-sdk-pt-br/flutter/face-liveness/handling-failures.md).
{% endhint %}

### `erro` (`CerttaError`)

Disparado quando um bloqueio técnico impede o SDK de iniciar ou concluir o processo, como permissões de câmera negadas, ausência de conexão com a internet ou falhas na inicialização de hardware.

| Campo   | Descrição                                             |
| ------- | ----------------------------------------------------- |
| `tipo`  | Identificador do erro mapeado a partir do SDK nativo. |
| `causa` | Contexto adicional da falha, quando presente.         |

| Evento                  | Causa típica                                                                                                                       |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `Erro de inicialização` | **`configurar`** não chamado, token vazio ou ID de usuário vazio, ou inválido **`maxRetryAttempts`**.                              |
| `Erro de permissão`     | Permissão da câmera (ou relacionada) negada.                                                                                       |
| `Erro de rede`          | Problemas de conectividade ou do lado do servidor aparecem como erros de rede.                                                     |
| `Erro de segurança`     | As verificações de segurança falharam.                                                                                             |
| `Erro desconhecido`     | Outras falhas não mapeadas para um caso específico.                                                                                |
| `Cancelado`             | Ocorre quando o usuário abandona o fluxo antes da conclusão, como ao pressionar o botão voltar ou enviar o app para segundo plano. |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.caf.io/caf-sdk/caf-sdk-pt-br/flutter/face-liveness.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.