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

# SelphID Configuration

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

**type:** *string*

Sets the name of the resource file that the Widget will use for its graphical configuration. This file is customizable and is located in the plugin in the folder **src/main/assets** for ***Android*** and in **ios/Frameworks** and from the Resources folder for ***iOS***. Its installation is transparent to the user; it will simply be added to the projects of the respective platforms during the plugin installation.\
See implementation example:

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

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

**type:** *boolean*

Indicates whether or not to show a screen with the captured image of the document after the analysis process. On this screen, the user is given the possibility to repeat the capture process if the image obtained from the document was not correct.\
See implementation example:

```
showResultAfterCapture: false
```

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

**type:** *SelphIDScanMode*

This enum is defined in the class ***SelphIDScanMode***, inside the file ***fphi\_sdkmobile\_selphid\_scan\_mode.dart***. It indicates the OCR scanning mode of the documents. Depending on the choice, several types of documents or one specific document will be scanned and searched. This mode can be of three types:

* ***SelphIDScanMode.CAP\_MODE\_GENERIC***: The generic mode that allows any type of document to be scanned regardless of the country or document type. The result of this mode is not as accurate as the following ones, but it allows several standard documents to be scanned.
* ***SelphIDScanMode.CAP\_MODE\_SEARCH***: The search mode will allow the use of a whitelist and blacklist, and will search the documents that meet those conditions. These conditions are indicated in the "specificData" variable. In this way, the search is limited by reducing the number of templates, making the search much more fine-tuned than in the generic case.
* ***SelphIDScanMode.CAP\_MODE\_SPECIFIC***: Search for a specific document. These conditions are indicated in the "specificData" property shown below.

See implementation example:

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

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

**type:** *string*

This property allows defining which documents will be scanned during the process, in case the scan mode (scanMode) is declared as GenericMode, SpecificMode or SearchMode.

An example configuration that allows all Spanish nationality documents to be scanned would be the following:

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

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

**type:** *boolean*

Sets whether the Widget should start in full-screen mode, hiding the status bar.

```
fullscreen: true;
```

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

**type:** *string*

It is a string that allows changing the Widget's localization and language. Examples of values it can have are the following:

* “es” for Spanish.
* “en” for English.
* “fr” for French.

Ultimately, it will depend on the name that appears in the strings.xml file for the language you want to select (strings-es.xml, strings-en.xml, strings-fr.xml).

In the resources zip, which is located inside the strings folder, the corresponding strings-xx.xml files can be added for each localization that needs to be incorporated into the Widget.

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

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

**type:** *string*

This enum is defined in the file `fphi_sdkmobile_selphid_document_type.dart`. Specified in the enum `SelphIDDocumentType`:

* ***DT\_IDCard***: Establishes that identity documents or cards will be captured.
* ***DT\_Passport***: Establishes that passports will be captured. (Additionally, the scanMode will have to be set to SelphIDScanMode.Generic)
* ***DT\_DriverLicense***: Establishes that driver's licenses will be captured.
* ***DT\_ForeignCard***: Establishes that foreign identity cards will be captured.
* ***DT\_Custom***: Encompasses documents that do not fall into any of the previous categories.

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

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

**type:** *double*

Specifies the compression quality of tokenFaceImage.

```
tokenFaceImage: 0.9;
```

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

**type:** *boolean*

This property configures the Widget to return the full camera image that was used to capture the document:

* rawFrontDocument: Front image of the raw document.
* rawBackDocument: Back image of the raw document.
* tokenRawFrontDocument: Tokenized of the raw front image of the document.
* tokenRawBackDocument: Tokenized of the raw back image of the document.

```
generateRawImages: true;
```

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

**type:** SelphIDTimeout

This is an enum that defines the timeout for capturing one side of the document. It has 4 possible values:

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

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

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

**type:** *boolean*

Sets whether the Widget should be launched in Tutorial mode. This allows the previous Widget tutorial to be shown, but WITHOUT carrying out the subsequent capture process. Useful in case the tutorial is to be shown in isolation.

```
tutorialOnly: true;
```

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

**type:** *string*

{% hint style="info" %}
This is an advanced property, and in most cases it is not necessary to modify it. Incorrect use can cause incorrect operation of the component.
{% endhint %}

Sets the absolute path of the file name where a video of the capture process will be recorded. The application is responsible for requesting the necessary permissions from the phone in case that path requires additional permissions. By default, the component will not perform any recording process unless a file path is specified by this method.

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

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

**type:** *string*

{% hint style="info" %}
This is an advanced property, and in most use cases it is not necessary to modify it. Incorrect use can cause incorrect operation of the component.
{% endhint %}

This property allows, through a string in xml format, configuring the document models that the Widget will try to capture. The definition of this model can be found, by default, in a models .xml inside the resources .zip. With this property, an application can update and replace, at runtime, the current document models of the component.

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

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

**type:** *string*

{% hint style="info" %}
This is an advanced property, and in most use cases it is not necessary to modify it. Incorrect use can cause incorrect operation of the component.
{% endhint %}

This property allows, through a string in xml format, configuring the current localization of the Widget. The definition of this model can be found, by default, in an internal translations folder inside the resources .zip. With this property, an application can update and replace, at runtime, the current localization of the component.

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

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

**type:** *string*

{% hint style="info" %}
This is an advanced property, and in most use cases it is not necessary to modify it. Incorrect use can cause incorrect operation of the component.
{% endhint %}

This property allows, through a string in xml format, configuring the views of the current component. The definition of this model can be found, by default, in a file called widget.xml inside the resources .zip. With this property, an application can update and replace, at runtime, the layout of the component's internal screens.

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

**showPreviousTip**

**type:** *boolean*

Displays a pre-launch screen with information about the process to be carried out and a start button.

<br>