> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades.md).

# Propriedades

Estas propriedades permitem personalizar o comportamento do fluxo de captura de documento.

## Constantes e tipagem

SelphID oferece tipos e constantes para facilitar sua implementação em ambientes tipados.

```javascript
import { CameraType, CameraPreferred } from '@facephi/selphid-web-component'
```

No React, o enum `CameraPreferred` (entre outros) também é exportado de `@facephi/sdk-web-react`.

> **Recomendação:** Configure as propriedades por meio de JavaScript, JSX ou dos bindings do seu framework (React, Vue, Angular, etc.). Evite a configuração nativa em HTML com atributos (`nombre-atributo="valor"`), pois isso pode fazer com que o tipado e o formato esperado pelo componente sejam perdidos.

***

## Propriedades de configuração do SelphID Widget

### Captura

* [allowUncertain](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/allowuncertain.md): Aumenta a permissividade em documentos não reconhecidos.
* [allowUnknown](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/allowunknown.md): Permite capturar qualquer documento com fotografia.
* [barcode](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/barcode.md): Ativa o leitor de códigos de barras e QR.
* [barcodeSide](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/barcodeside.md): Lado do documento onde o código é lido.
* [blurredThreshold](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/blurredthreshold.md): Limite de tolerância ao desfoque.
* [captureRetries](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/captureretries.md): Número máximo de tentativas de captura.
* [captureTimeout](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/capturetimeout.md): Tempo limite de captura por tentativa (segundos).
* [country](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/country.md): País do documento em ISO-2. **Obsoleto:** usar `countryFilter`.
* [countryFilter](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/countryfilter.md): Países permitidos em ISO-2. **Recomendado:** `enabledCountries`.
* [documentType](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/documenttype.md): Tipos de documento permitidos na captura.
* [expectedSides](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/expectedsides.md): Número de lados do documento a capturar.
* [maxAllowedMismatches](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/maxallowedmismatches.md): Erros de OCR permitidos por palavra.
* [maxAttempts](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/maxattempts.md): Número máximo de tentativas de captura do documento.
* [progressiveMismatches](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/progressivemismatches.md): Incremento de permissividade em cada nova tentativa.
* [retryCurrentSide](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/retrycurrentside.md): Tenta novamente apenas o lado atual do documento.
* [rules](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/rules.md): Regras para filtrar a captura por país.

### Extração

* [anonymizationMode](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/anonymizationmode.md): Modo de anonimização dos dados extraídos.
* [capturePadding](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/capturepadding.md): Margem adicionada à imagem capturada.
* [cropFactor](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/cropfactor.md): Fator de escala do recorte do documento.
* [imageFormat](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/imageformat.md): Formato das imagens retornadas.
* [imageQuality](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/imagequality.md): Compressão JPEG (0.0–1.0).
* [tokenize](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/tokenize.md): Ativa a tokenização dos resultados.

### Câmera

* [cameraHeight](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/cameraheight.md): Resolução vertical preferida da câmera.
* [cameraId](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/cameraid.md): Identificador da câmera.
* [cameraSwitch](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/cameraswitch.md): Exibe o botão para trocar de câmera.
* [cameraType](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/cameratype.md): Tipo de câmera (frontal ou traseira). **Recomendado:** `cameraPreferred`.
* [cameraWidth](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/camerawidth.md): Resolução horizontal preferida da câmera.
* [dpi](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/dpi.md): DPI das imagens extraídas.
* [externalCamera](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/externalcamera.md): Fluxo de vídeo externo para a captura.

### Personalização

* [audible](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/audible.md): Ativa a leitura de textos em voz alta.
* [cameraOverflow](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/cameraoverflow.md): Exibe toda a imagem da câmera como fundo.
* [chooseDocument](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/choosedocument.md): Ativa a seleção prévia de documento. **Recomendado:** `showDocumentSelector`.
* [disableExit](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/disableexit.md): Oculta o botão de fechar o Widget. **Recomendado:** `showExitButton`.
* [disableTutorial](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/disabletutorial.md): Desativa o acesso ao tutorial. **Recomendado:** `showTutorial`.
* [enableDocumentFlip](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/enabledocumentflip.md): Ativa a animação de giro do documento.
* [initialTip](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/initialtip.md): Exibe uma dica antes da captura. **Recomendado:** `showPreviousTip`.
* [initialTipHeight](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/initialtipheight.md): Altura da dica inicial em pixels.
* [initialTipWidth](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/initialtipwidth.md): Largura da dica inicial em pixels.
* [tipAnimations](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/tipanimations.md): Animações da dica inicial (mobile e desktop).
* [loadingAnimation](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/loadinganimation.md): Caminho da animação de carregamento.
* [logo](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/logo.md): Caminho do logo personalizado.
* [previewImage](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/previewimage.md): Exibe a prévia após a captura. **Recomendado:** `showResultAfterCapture`.
* [tutorialAnimations](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/tutorialanimations.md): Animações personalizadas do tutorial.
* [tutorialModal](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/tutorialmodal.md): Exibe o tutorial em modo modal.

### Configuração interna

* [advancedTracking](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/advancedtracking.md): Ativa a geração de Tracking avançado.
* [androidWebViewBehaviour](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/androidwebviewbehaviour.md): Comportamento em WebView do Android.
* [engineFallback](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/enginefallback.md): Habilita o motor secundário.
* [engineLocation](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/enginelocation.md): Caminho ou CDN dos recursos do motor.
* [errorTimer](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/errortimer.md): Duração das telas de erro final.
* [settingsStrictness](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/settingsstrictness.md): Exibe erro se houver parâmetros configurados incorretamente.

### Gravação de vídeo

* [enableVideoTimer](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/enablevideotimer.md): Exibe um temporizador durante a gravação.
* [videoRecord](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/videorecord.md): Ativa a Gravação de Vídeo.
* [videoRecordAudio](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/videorecordaudio.md): Grava áudio na gravação local.
* [videoRecordQuality](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/videorecordquality.md): Qualidade da Gravação de Vídeo.
* [videoRecordRate](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/videorecordrate.md): Taxa de quadros da gravação remota.
* [videoRecordType](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/videorecordtype.md): Tipo de gravação (local ou remota).

### Ferramentas de desenvolvedor

* [debug](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/debug.md): Ativa o modo de depuração na tela.
* [showLog](/docs.facephi-pt-br/sdks/sdk-web/componentes/selphid-documentos/propiedades/showlog.md): Emite informações detalhadas no console.

***

## Compatibilidade e validação de propriedades

Algumas propriedades foram renomeadas. O nome legacy continua sendo o principal e operacional nesta Versão, enquanto o novo nome é o **recomendado**. Regras de resolução:

* **Precedência:** se você definir ao mesmo tempo o nome legacy e o novo, prevalece o **novo** e é emitido um aviso de precedência no console.
* **Somente legacy:** usar somente o nome legacy emite um aviso de depreciação no console. O nome legacy será removido na próxima Versão major.
* **Propriedade desconhecida:** uma propriedade não reconhecida é **ignorada silenciosamente** sempre.
* **Validação (**[**settingsStrictness**](/docs.facephi-pt-br/sdks/sdk-web/componentes/sdk-provider/propiedades/settingsstrictness.md)**, por padrão tolerante):** no modo tolerante, um valor inválido é substituído por seu valor padrão e um aviso é emitido; no modo estrito, o SDK é interrompido com um erro bloqueante.