> 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/sdk-lite/sdk-lite-english-pt-br/configuracao/android/configuration/ui-customization.md).

# Personalização da interface

O Face Liveness Lite permite adaptar a tela de liveness à sua marca: cores, título, logo, ícone de fechar, fonte e o efeito de máscara.

Passe um `UiCustomization` por meio de `CafLivenessConfig.uiCustomization`. Todos os campos são opcionais — tudo o que você omitir mantém a aparência padrão, então você pode personalizar apenas o que precisar.

### Uso básico

```kotlin
val uiCustomization = UiCustomization(
    font = LivenessFont.ResFont(R.font.your_font),
    appBar = AppBarCustomization(
        title = "Verificação de identidade",
        titleColor = ContextCompat.getColor(context, R.color.white),
        color = ContextCompat.getColor(context, R.color.brand_navy),
        logoIcon = R.drawable.your_logo,
        closeButton = R.drawable.your_close_icon,
    ),
    mask = MaskCustomization(
        isBlurEnabled = true,
        color = ContextCompat.getColor(context, R.color.brand_navy),
    ),
    prompt = PromptCustomization(
        textColor = ContextCompat.getColor(context, R.color.white),
        backgroundColor = ContextCompat.getColor(context, R.color.brand_green),
        isRounded = true,
    ),
)

val config = CafLivenessConfig(
    mobileToken = mobileToken,
    personId = personId,
    uiCustomization = uiCustomization,
)

CafFaceLivenessLite.instance.configure(context, config)
CafFaceLivenessLite.instance.startLiveness { event ->
    // lidar com eventos
}
```

### UiCustomization

O objeto raiz. Cada grupo é opcional e pode ser omitido.

<table><thead><tr><th width="108.94921875">Parâmetro</th><th>Tipo</th><th width="102.421875">Padrão</th><th>Descrição</th></tr></thead><tbody><tr><td><code>font</code></td><td><code>LivenessFont?</code></td><td><code>null</code></td><td>Fonte personalizada aplicada ao título e ao texto da instrução.</td></tr><tr><td><code>mask</code></td><td><code>MaskCustomization?</code></td><td><code>null</code></td><td>Aparência da área ao redor do oval do rosto.</td></tr><tr><td><code>appBar</code></td><td><code>AppBarCustomization?</code></td><td><code>null</code></td><td>Título, cores, logo e ícone de fechar da barra superior.</td></tr><tr><td><code>prompt</code></td><td><code>PromptCustomization?</code></td><td><code>null</code></td><td>Aparência da caixa de instruções exibida ao usuário.</td></tr></tbody></table>

### AppBarCustomization

A barra no topo da tela de liveness.

| Parâmetro     | Tipo                | Padrão                          | Descrição                                         |
| ------------- | ------------------- | ------------------------------- | ------------------------------------------------- |
| `title`       | `String?`           | Vazio                           | Título exibido durante a verificação de liveness. |
| `titleColor`  | `@ColorInt Int?`    | Branco                          | Cor do texto do título.                           |
| `color`       | `@ColorInt Int?`    | Transparente                    | Cor de fundo da barra superior.                   |
| `logoIcon`    | `@DrawableRes Int?` | Sem logo                        | Logo exibido na barra superior.                   |
| `closeButton` | `@DrawableRes Int?` | Padrão (seta de voltar, branca) | Ícone do botão que fecha a tela de liveness.      |

### MaskCustomization

A área fora do oval onde o usuário posiciona o rosto.

| Parâmetro       | Tipo             | Padrão                 | Descrição                                                                                                        |
| --------------- | ---------------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `isBlurEnabled` | `Boolean`        | `true`                 | Se os efeitos de desfoque e vinheta são aplicados fora do oval. Defina como `false` para uma sobreposição plana. |
| `color`         | `@ColorInt Int?` | Preto semitransparente | Cor da área fora do oval. Use uma cor com alfa para manter a pré-visualização da câmera parcialmente visível.    |

### PromptCustomization

A caixa que exibe instruções ao usuário durante a verificação.

| Parâmetro         | Tipo             | Padrão                 | Descrição                                         |
| ----------------- | ---------------- | ---------------------- | ------------------------------------------------- |
| `textColor`       | `@ColorInt Int?` | Branco                 | Cor do texto da instrução.                        |
| `backgroundColor` | `@ColorInt Int?` | Preto semitransparente | Cor de fundo da caixa de instruções.              |
| `isRounded`       | `Boolean`        | `true`                 | Se a caixa de instruções tem cantos arredondados. |

### LivenessFont

Aplicada ao título e ao texto da instrução.

| Opção                   | Parâmetro           | Descrição                                                      |
| ----------------------- | ------------------- | -------------------------------------------------------------- |
| `LivenessFont.ResFont`  | `@FontRes res: Int` | Fonte dos recursos do seu app, por exemplo `R.font.your_font`. |
| `LivenessFont.PathFont` | `path: String`      | Fonte carregada de um caminho de arquivo.                      |

```kotlin
UiCustomization(font = LivenessFont.ResFont(R.font.your_font))
```

### Cores, ícones e fontes

* **As cores são valores de cor, não recursos de cor.** Os campos são anotados `@ColorInt`, então resolva os recursos primeiro com `ContextCompat.getColor(context, R.color.your_color)`, ou use um literal como `Color.WHITE` / `0xFF1B1B3A.toInt()`. Passar `R.color.your_color` diretamente produzirá a cor errada.
* **Ícones e fontes são IDs de recursos** (`@DrawableRes`, `@FontRes`).
* **Recursos inválidos são ignorados.** Se um recurso de ícone ou fonte não puder ser carregado, a sessão de liveness continua com a aparência padrão em vez de falhar.
* **Definir um valor como `null` significa "usar o padrão"**, não "ocultá-lo". Passar `closeButton = null` mantém o ícone de fechar padrão em vez de remover o botão.

### O que não pode ser personalizado

Alguns aspectos da tela de liveness são fixos pelo SDK para proteger a integridade da verificação:

* Orientação da tela (sempre em retrato).
* Capturas de tela (sempre desativadas).
* O filtro de pré-visualização da câmera, que é definido pela configuração da sua conta.
* Os textos das instruções. Eles podem ser localizados da maneira padrão do Android — veja [Localização de strings](https://github.com/iProov/android#string-localization--customization).

### Acessibilidade

As cores padrão e as proporções de contraste são verificadas conforme **WCAG 2.1 AA** diretrizes. Personalizar as cores pode invalidar essa conformidade, então verifique o contraste entre texto e plano de fundo — especialmente `prompt.textColor` em relação a `prompt.backgroundColor`, e `appBar.titleColor` em relação a `appBar.color`.


---

# 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/sdk-lite/sdk-lite-english-pt-br/configuracao/android/configuration/ui-customization.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.
