> 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/produtos/idv-suite/flujos-and-integraciones/configuracion-tecnica-del-cliente/sdk-mobile/idv-mobile/componente-documento.md).

# Componente - Documento

<figure><img src="/files/e7448d3ab15c5b853ef0d1ecf52120243259fd7b" alt="" width="324"><figcaption></figcaption></figure>

A Captura de Documento deve ser configurada.

<figure><img src="/files/af6e23b8f55763da707c711db56fc42b00269071" alt="" width="263"><figcaption></figcaption></figure>

Para fazer isso, clicamos no ícone da engrenagem; se ele tiver um ponto vermelho, significa que há um parâmetro obrigatório que não está configurado e não poderemos salvar o Fluxo.

#### Tutorial antes da captura

Tipo: Boolean

Padrão: Ativado

Nome do parâmetro no SDK: *showTutorial*

Se ativado, o app móvel mostrará um ícone (i) de informação no canto superior direito da tela de "Dica inicial antes da captura"; esse botão mostra um tutorial mais detalhado de como realizar a captura.

#### Dica inicial antes da captura

Tipo: Boolean

Padrão: Ativado

Nome do parâmetro no SDK: *showPreviousTip*

Se ativado, o app móvel mostrará uma tela com um breve tutorial antes do início do processo de captura.

#### Tela de diagnóstico de erros

Tipo: Boolean

Padrão: Ativado

Nome do parâmetro no SDK: *showDiagnostic*

Se ativado, o app móvel mostrará uma tela indicando o erro específico que impediu concluir o processo de captura. Cada erro é tratado de forma diferente e algumas telas apresentarão botões para fechar, tentar novamente ou até ir para a configuração do dispositivo.

#### Pré-visualizar imagem capturada

Tipo: Boolean

Padrão: Ativado

Nome do parâmetro no SDK: *showResultAfterCapture*

Se ativado, o app móvel mostrará uma tela com a imagem capturada para que o usuário confirme se ela está sendo exibida corretamente ou prefira refazê-la.

#### Ativar vibração durante a captura

Tipo: Boolean

Padrão: Ativado

Nome do parâmetro no SDK: *vibrationEnabled*

Se ativado, o app móvel dará feedback ao usuário por meio de pulsos hápticos (vibrações).

#### Modo assistente para a captura de documento

Tipo: Boolean

Padrão: Ativado

Nome do parâmetro no SDK: *wizardMode*

Se ativado, o processo fica configurado para realizar a captura de ambas as partes (frente e verso) do documento uma após a outra. Nesse modo, o Widget seria iniciado apenas uma vez e, ao terminar de capturar a frente, continuaria em seguida com o verso se o documento o tiver.

#### Modo de escaneamento de documento

Tipo: Seletor

Padrão: Modo de busca

Nome do parâmetro no SDK: *scanMode*

Indica o modo de escaneamento OCR dos documentos. Dependendo da escolha, serão escaneados e buscados vários tipos de documentos ou um em específico. Esse modo pode ser de três tipos:

* **Modo genérico (*****MODE\_GENERIC*****)**: permite escanear qualquer tipo de documento, independentemente do país ou do tipo de documento. O resultado desse modo não é tão preciso quanto os seguintes, mas permite escanear vários documentos padrão.
* **Modo de busca (*****MODE\_SEARCH*****)**: permitirá utilizar uma whitelist e blacklist, e buscará nos documentos que atendam a essas condições. Essas condições são indicadas na variável "País" (*specificData*). Dessa forma, é possível realizar a busca limitando o número de templates e tornando a busca muito mais precisa do que no caso genérico.
* **Modo específico (*****MODE\_SPECIFIC*****)**: Busca de um documento específico. Essas condições são indicadas na propriedade "País" (*specificData*) que é mostrada a seguir.

### Sem seletor de documentos

#### País

Tipo: String

Padrão: ES|\<ALL>

Nome do parâmetro no SDK: *specificData*

Esta propriedade permite definir quais documentos serão escaneados durante o processo, caso seja declarado o modo de escaneamento *busca* ou *específico*. O exemplo *ES|\<ALL>* indica que fará a busca por **todos** os documentos emitidos pela Espanha.

A chave do país deve ser sua ISO2.

#### Tipo de documento

Tipo: Seletor

Padrão: Documento de identidade

Nome do parâmetro no SDK: *documentType*

O tipo de documento que será lido.

* **Documento de identidade**: O Widget fica configurado para realizar a captura de documentos de identidade.
* **Passaporte**: O Widget fica configurado para realizar a captura de passaportes.
* **Visto**: O Widget fica configurado para realizar a captura de vistos.
* **Carteira de motorista**: O Widget fica configurado para realizar a captura de carteiras de motorista.
* **Cartão de estrangeiro**: O Widget fica configurado para realizar a captura de documentos estrangeiros.
* **Cartão de crédito**: O Widget fica configurado para realizar a captura de cartões de crédito.
* **Personalizado**: O Widget fica configurado para realizar a captura de outro tipo de documentos que não correspondem a nenhuma das categorias anteriores.

### Com seletor de documentos

#### **showDocumentSelector**

Tipo: Boolean

Padrão: *false*

Nome do parâmetro no SDK: *showDocumentSelector*

Ativação da tela de seletor de documentos. Ela será exibida assim que o controlador for iniciado.

#### **enabledCountries**

Tipo: Array of Strings \[String]

Padrão: *null*

Nome do parâmetro no SDK: *enabledCountries*

Lista de países em ISO2 que aparecerão no seletor. Se o valor for nulo ou não contiver valores válidos, serão exibidos todos os disponíveis no SDK.

#### **enabledDocumentTypes**

Tipo: Array of Strings \[String]

Padrão: *null*

Nome do parâmetro no SDK: *enabledDocumentTypes*

Lista de tipos de documentos que aparecerão no seletor de tipos de documentos. Se o valor for nulo ou não contiver valores, serão exibidos todos os disponíveis no SDK.

### Parâmetros avançados

#### Lado a capturar

Tipo: Seletor

Padrão: Frente

Nome do parâmetro no SDK: *documentSide*

O lado do documento pelo qual se começa a capturar. Este parâmetro NÃO define se será capturado apenas um lado ou ambos.

#### Arquivo de recursos

Tipo: String

Padrão: *vazio - PREENCHER*

Nome do parâmetro no SDK: *resourcesPath*

O nome do arquivo zip que é entregue junto com a dependência de FPHISelphIDWidget. Esse arquivo deve estar com esse mesmo nome entre os assets da aplicação que integre o Fluxo.

A estrutura do nome dos zips que costumam ser publicados é resources-${PRODUCT}-{$VERSION}.zip (i.e. *resources-selphid-2-0.zip)*

#### Ativar modo de depuração

Tipo: Boolean

Padrão: Desativado

Nome do parâmetro no SDK: *debug*

Se ativado, a captura será feita no modo *Debug.*

#### Tempo máximo de captura

Tipo: Seletor

Padrão: Médio

Nome do parâmetro no SDK: *Timeout*

O tempo que transcorre desde o início da captura até que ocorra um erro por *Timeout.*

*Curto 15s - Médio 20s - Longo 25s - Muito longo 60s*

#### Qualidade da imagem do Token

Tipo: Float

Padrão: *vazio - O SDK usará 0,95*

Nome do parâmetro no SDK: *tokenImageQuality*

Valor decimal entre 0 e 1 que indica a compressão da imagem tokenizada usada para os serviços de verificação.

#### Caminho do arquivo de vídeo

Tipo: String

Padrão: *vazio*

Nome do parâmetro no SDK: *videoFilename*

Se o valor for diferente de vazio, o processo de Captura de Documento será gravado como um .mp4 no caminho indicado; dessa forma, o integrador pode obtê-lo acessando-o.

#### Parâmetros\*

Tipo: Dicionário \<String,String>

Padrão: *vazio*

Nome do parâmetro no SDK: *params*

Este dicionário é para configurações específicas e só deve ser usado quando tiver sido indicado pela Facephi devido a um caso de uso especial.
