> 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-mobile/framework-plugins/extras/selphid/selphid-configuracion.md).

# Configuração do SelphID

#### resourcesPath <a href="#id-31-resourcespath" id="id-31-resourcespath"></a>

**type:** *string*

Define o nome do arquivo de recursos que o widget utilizará para sua configuração gráfica. Este arquivo é personalizável e se encontra no complemento, na pasta **src/main/assets** para ***Android*** e em **ios/Frameworks** e da pasta Resources para ***iOS***. Sua instalação é transparente para o usuário, simplesmente será adicionada aos projetos das respectivas plataformas durante a instalação do complemento.\
Veja exemplo de implementação:

```
resourcesPath: "fphi-selphid-widget-resources-sdk.zip"
```

#### 3.2 ShowResultAfterCapture <a href="#id-32-showresultaftercapture" id="id-32-showresultaftercapture"></a>

**type:** *boolean*

Indica se deve mostrar ou não uma tela com a imagem capturada do documento após o processo de análise. Nessa tela, é dada ao usuário a possibilidade de repetir o processo de captura se a imagem obtida do documento não estiver correta.\
Veja exemplo de implementação:

```
showResultAfterCapture: false
```

#### 3.3 ScanMode <a href="#id-33-scanmode" id="id-33-scanmode"></a>

**type:** *SelphIDScanMode*

Este enumerado é definido na classe ***SelphIDScanMode***, dentro do arquivo ***fphi\_sdkmobile\_selphid\_scan\_mode.dart***. Indica o modo de escaneamento OCR dos documentos. Dependendo da escolha, serão escaneados e buscados vários tipos de documentos ou um específico. Esse modo pode ser de três tipos:

* ***SelphIDScanMode.CAP\_MODE\_GENERIC***: O modo genérico que permite escanear qualquer tipo de documento, independente 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.
* ***SelphIDScanMode.CAP\_MODE\_SEARCH***: O modo de busca 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 "specificData". Desse modo, é possível realizar a busca restringindo o número de templates, tornando a busca muito mais precisa do que no caso genérico.
* ***SelphIDScanMode.CAP\_MODE\_SPECIFIC***: Busca de um documento específico. Essas condições são indicadas na propriedade "specificData" mostrada a seguir.

Veja exemplo de implementação:

```
scanMode: SelphIDScanMode.CAP_MODE_SEARCH;
```

#### 3.4 SpecificData <a href="#id-34-specificdata" id="id-34-specificdata"></a>

**type:** *string*

Esta propriedade permite definir quais documentos serão escaneados durante o processo, caso seja declarado o modo de escaneamento (scanMode) como GenericMode, SpecificMode ou SearchMode.

Um exemplo de configuração que permita escanear todos os documentos de nacionalidade espanhola seria o seguinte:

```
specificData: “<ES|ALL>”; // Spanish ISO code(ES)
```

#### 3.5 FullScreen <a href="#id-35-fullscreen" id="id-35-fullscreen"></a>

**type:** *boolean*

Define se deseja que o widget seja iniciado em modo de tela cheia, ocultando a barra de status.

```
fullscreen: true;
```

#### 3.6 Locale <a href="#id-36-locale" id="id-36-locale"></a>

**type:** *string*

É uma string que permite alterar a localização e o idioma do widget. Exemplos de valores que pode ter são os seguintes:

* “es” para espanhol.
* “en” para inglês.
* “fr” para francês.

Em suma, dependerá do nome que aparecer no arquivo strings.xml do idioma que se deseja selecionar (strings-es.xml, strings-en.xml, strings-fr.xml).

No zip de recursos, que se encontra dentro da pasta strings, podem ser adicionados os arquivos strings-xx.xml correspondentes a cada localização que se deseja incorporar ao widget.

```
locale: "es";
```

#### SelphIDDocumentType <a href="#id-37-selphiddocumenttype" id="id-37-selphiddocumenttype"></a>

**type:** *string*

Este enumerado é definido no arquivo `fphi_sdkmobile_selphid_document_type.dart`. Especificado no enum `SelphIDDocumentType`:

* ***DT\_IDCard***: Define que serão capturados documentos de identidade ou cartões.
* ***DT\_Passport***: Define que serão capturados passaportes. (Adicionalmente será necessário definir o scanMode como SelphIDScanMode.Generic)
* ***DT\_DriverLicense***: Define que serão capturadas carteiras de motorista.
* ***DT\_ForeignCard***: Define que serão capturadas carteiras de identidade de estrangeiros.
* ***DT\_Custom***: Engloba documentos que não se encontram em nenhuma das categorias anteriores.

```
documentType: SelphIDDocumentType.DT_IDCARD;
```

#### tokenImageQuality <a href="#id-38-tokenimagequality" id="id-38-tokenimagequality"></a>

**type:** *double*

Especifica a qualidade de compressão do tokenFaceImage.

```
tokenFaceImage: 0.9;
```

#### generateRawImages <a href="#id-39-generaterawimages" id="id-39-generaterawimages"></a>

**type:** *boolean*

Esta propriedade configura o widget para devolver a imagem completa da câmera que foi utilizada para capturar o documento:

* rawFrontDocument: Imagem frontal do documento sem processamento.
* rawBackDocument: Imagem traseira do documento sem processamento.
* tokenRawFrontDocument: Tokenizado da imagem frontal do documento sem processamento.
* tokenRawBackDocument: Tokenizado da imagem traseira do documento sem processamento.

```
generateRawImages: true;
```

#### tempo limite <a href="#id-310-selphidtimeout" id="id-310-selphidtimeout"></a>

**type:** SelphIDTimeout

É um enumerado que define o timeout da captura de um lado do documento. Tem 4 valores possíveis:

* *SelphIDTimeout*.**Short**: 15 segundos.
* *SelphIDTimeout*.**Medium**: 20 segundos.
* *SelphIDTimeout*.**Long**: 25 segundos.
* *SelphIDTimeout*.**VeryLong**: 60 segundos.

```
timeout = SelphIDTimeout.T_SHORT;
```

#### tutorialOnly <a href="#id-311-tutorialonly" id="id-311-tutorialonly"></a>

**type:** *boolean*

Define se deseja iniciar o widget em modo Tutorial. Isso permite mostrar o tutorial prévio do widget, mas SEM realizar o processo posterior de captura. Útil caso se deseje mostrar o tutorial de forma isolada.

```
tutorialOnly: true;
```

#### videoFilename <a href="#id-312-videofilename" id="id-312-videofilename"></a>

**type:** *string*

{% hint style="info" %}
Esta é uma propriedade avançada e, na maioria dos casos, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
{% endhint %}

Define o caminho absoluto do nome do arquivo no qual será gravado um vídeo do processo de captura. A aplicação é responsável por solicitar as permissões necessárias ao telefone caso esse caminho exija permissões adicionais. O componente, por padrão, não realizará nenhum processo de gravação a menos que seja especificado um caminho de arquivo por meio deste método.

```
videoFilename: “\<videofile-path\>“;
```

#### documentModels <a href="#id-313-documentmodels" id="id-313-documentmodels"></a>

**type:** *string*

{% hint style="info" %}
Esta é uma propriedade avançada e, na maioria dos casos de uso, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
{% endhint %}

Esta propriedade permite, por meio de uma cadeia no formato xml, configurar o modelamento dos documentos que o widget tentará capturar. A definição desse modelamento pode ser encontrada, por padrão, em um .xml de modelos dentro do .zip de recursos. Com esta propriedade, permite-se a uma aplicação atualizar e substituir, em execução, os modelamentos dos documentos atuais do componente.

```
documentModels: “\<document-models-content-string\>“;
```

#### translationsContent <a href="#id-314-translationscontent" id="id-314-translationscontent"></a>

**type:** *string*

{% hint style="info" %}
Esta é uma propriedade avançada e, na maioria dos casos de uso, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
{% endhint %}

Esta propriedade permite, por meio de uma cadeia no formato xml, configurar a localização atual do widget. A definição dessa modelagem pode ser encontrada, por padrão, em uma pasta interna de traduções dentro do .zip de recursos. Com esta propriedade, permite-se a uma aplicação atualizar e substituir, em execução, a localização atual do componente.

```
translationsContent: “\<translation-content-string\>“;
```

#### viewsContent <a href="#id-315-viewscontent" id="id-315-viewscontent"></a>

**type:** *string*

{% hint style="info" %}
Esta é uma propriedade avançada e, na maioria dos casos de uso, não é necessário modificá-la. Seu uso incorreto pode provocar um funcionamento incorreto do componente.
{% endhint %}

Esta propriedade permite, por meio de uma cadeia no formato xml, configurar as views do componente atual. A definição desse modelamento pode ser encontrada, por padrão, em um arquivo chamado widget.xml dentro do .zip de recursos. Com esta propriedade, permite-se a uma aplicação atualizar e substituir, em execução, o layout das telas internas do componente.

```
viewsContent: “\<views-content-string\>“;
```

**showPreviousTip**

**type:** *boolean*

Mostra uma tela de pré-lançamento com informações sobre o processo a ser realizado e um botão de início.

<br>