> 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/react-native/standalone-modules/face-liveness/typescript-references.md).

# Referências do TypeScript

## Tipos

### `FaceLivenessResponse`

| Campo       | Tipo                                        | Descrição                                                       |
| ----------- | ------------------------------------------- | --------------------------------------------------------------- |
| `resultado` | [FaceLivenessResult](#facelivenessresult)   | Mostra quando o Face Liveness retorna uma captura bem-sucedida. |
| `falha`     | [FaceLivenessFailure](#facelivenessfailure) | Mostra quando o Face Liveness retorna uma captura de falha.     |
| `erro`      | [FaceLivenessError](#facelivenesserror)     | Mostra quando o Face Liveness retorna algum erro.               |
| `cancelado` | booleano                                    | Mostra quando o usuário cancela a verificação de vivacidade.    |
| `isLoading` | booleano                                    | Mostra quando o Face Liveness está carregando.                  |

### `FaceLivenessResult`

| Campo            | Tipo   | Descrição                                                         |
| ---------------- | ------ | ----------------------------------------------------------------- |
| `signedResponse` | string | A resposta assinada confirmando que a selfie capturada é genuína. |

### `FaceLivenessFailure`

| Campo      | Tipo   | Descrição                            |
| ---------- | ------ | ------------------------------------ |
| `mensagem` | string | Mensagem detalhada de falha.         |
| `tipo`     | string | Mensagem detalhada do tipo de falha. |

### `FaceLivenessError`

| Campo      | Tipo           | Descrição                         |
| ---------- | -------------- | --------------------------------- |
| `mensagem` | string         | Mensagem detalhada de erro.       |
| `tipo`     | [Erro](#error) | Enum que descreve o tipo de erro. |

### `FaceLivenessSettings`

| Campo                    | Tipo              | Descrição                                                                                                                                              | Android | iOS |
| ------------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | :-----: | :-: |
| `cafStage`               | [Estágio](#stage) | Usado para redirecionar o SDK para o estágio desejado na API CAF.                                                                                      |    ✅    |  ✅  |
| `filter`                 | [Filtro](#filter) | Usado para alterar o filtro do SDK.                                                                                                                    |    ✅    |  ✅  |
| `imageUrlExpirationTime` | [Tempo](#time)    | Usado para personalizar o tempo de expiração da URL da imagem.                                                                                         |    ✅    |  ✅  |
| `enableScreenshots`      | booleano          | Usado para habilitar capturas de tela durante a varredura do SDK. Desativado por padrão por motivos de segurança.                                      |    ✅    |  ✅  |
| `loadingScreen`          | booleano          | Usado para habilitar uma barra de progresso de carregamento padrão durante eventos de carregamento.                                                    |    ✅    |  ✅  |
| `certificates`           | string\[]         | Usado para definir certificados fixados para a implementação de reverse proxy.                                                                         |    ✅    |  ✅  |
| `faceLivenessBaseUrl`    | string            | Usado para habilitar o uso de reverse proxy para executar o Face Liveness. Se usado, os certificados devem ser definidos com o método setCertificates. |    ✅    |  ✅  |
| `authenticationBaseUrl`  | string            | Usado para habilitar o uso de reverse proxy para executar as autenticações do SDK.                                                                     |    ✅    |  ✅  |

## Enumerações

### `Estágio`

| Campo  | Descrição             | Android | iOS |
| ------ | --------------------- | :-----: | :-: |
| `BETA` | Ambiente beta.        |    ✅    |  ✅  |
| `PROD` | Ambiente de produção. |    ✅    |  ✅  |

### `Filtro`

| Campo          | Descrição                                                    | Android | iOS |
| -------------- | ------------------------------------------------------------ | :-----: | :-: |
| `LINE_DRAWING` | Máscara alternativa para a verificação de vivacidade facial. |    ✅    |  ✅  |
| `NATURAL`      | Máscara normal para a verificação de vivacidade facial.      |    ✅    |  ✅  |

### `Tempo`

| Campo         | Descrição                                                       | Android | iOS |
| ------------- | --------------------------------------------------------------- | :-----: | :-: |
| `THREE_HOURS` | O tempo de expiração da URL da imagem expira em três horas.     |    ✅    |  ✅  |
| `THIRTY_DAYS` | O tempo de expiração da URL da imagem expira em trinta dias.    |    ✅    |  ✅  |
| `THIRTY_MIN`  | O tempo de expiração da URL da imagem expira em trinta minutos. |    ❌    |  ✅  |

### `Erro`

| Campo                  | Descrição                                                                       | Android | iOS |
| ---------------------- | ------------------------------------------------------------------------------- | :-----: | :-: |
| `UnknownException`     | Indica um problema desconhecido.                                                |    ✅    |  ✅  |
| `CameraPermission`     | Indica que a permissão da câmera é necessária para a verificação de vivacidade. |    ✅    |  ✅  |
| `NetworkException`     | Indica que ocorreu uma exceção relacionada à rede durante a verificação.        |    ✅    |  ✅  |
| `ServerException`      | Indica que ocorreu uma exceção no lado do servidor durante a verificação.       |    ✅    |  ✅  |
| `TokenException`       | Indica um problema com o token usado para verificação.                          |    ✅    |  ✅  |
| `UnsupportedDevice`    | Indica que o dispositivo não é compatível com a verificação de vivacidade.      |    ✅    |  ✅  |
| `CertificateException` | Indica que ocorreu uma exceção no pinning de certificados.                      |    ✅    |  ✅  |


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.caf.io/caf-sdk/caf-sdk-pt-br/react-native/standalone-modules/face-liveness/typescript-references.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.