> 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/sdks/sdk-mobile/framework-plugins/react-native/componentes/captura-de-documentos.md).

# Captura de documentos - SelphID

La captura de documentos se realiza con el ***SelphID Plugin***.

Este componente se encarga de realizar capturas de documentos de identidad y del análisis de los datos obtenidos. Sus principales procesos son:

* Gestión interna de cámaras y permisos.
* Asistente en los procesos de captura de la parte frontal y trasera del documento.
* Extracción de la información contenida en el documento.
* Obtención de las imágenes del dorso y reverso del documento, así como otras imagénes incluidas en el documento: cara del usuario, firma del usuario,...
* Alto nivel de configuración: diferentes países, idiomas, tipos de documentos...

***

## Dependencias <a href="#id-2-dependencia" id="id-2-dependencia"></a>

### React:

```swift
npm install @facephi/sdk-selphid-react-native@<versión>
```

### Android - Gradle:

```kotlin
implementation "com.facephi.androidsdk:selphid_component:$version"
```

### iOS - Cocoapods:

```swift
pod 'FPHISDKSelphIDComponent', '~> $version'
```

## Métodos disponibles

Este componente contiene varios métodos que ejecutan diferentes funcionalidades:

<table data-header-hidden><thead><tr><th width="233.64453125"></th><th></th></tr></thead><tbody><tr><td><strong>Método</strong></td><td><strong>Descripción</strong></td></tr><tr><td>launchSelphID</td><td>Controlador principal de captura de documentos</td></tr></tbody></table>

## Método selphid <a href="#id-4-lanzamiento-simplificado" id="id-4-lanzamiento-simplificado"></a>

Una vez iniciado el SDK y creada una nueva operación se podrá lanzar el componente. Se podrá hacer uso de cualquiera de sus controladores para ejecutar su funcionalidad.

Lanzamiento de la captura facial:

```javascript
export function selphid(config: SelphidConfiguration): Promise<SelphidResult> {
  return SdkSelphid.selphid(config);
}
```

## Configuración básica <a href="#id-5-configuracion-basica" id="id-5-configuracion-basica"></a>

Para lanzar el componente actual, se deberá crear un objeto ***SelphidConfiguration*** que será la configuración del controlador del componente.

La configuración básica necesaria para es la siguiente:

```typescript
 export interface SelphidConfiguration {
  debug?: boolean;
  fullscreen?: boolean;
  tokenImageQuality?: number;
  timeout?: SdkTimeout;
  showResultAfterCapture?: boolean;
  showTutorial?: boolean;
  tutorialOnly?: boolean;
  scanMode?: SdkScanMode;
  specificData?: string;
  documentType?: SdkDocumentType;
  videoFilename?: string;
  documentModels?: string;
  generateRawImages?: boolean;
  translationsContent?: string;
  viewsContent?: string;
  cameraId?: number;
  params?: any;
  resourcesPath?: string;
  tokenPrevCaptureData?: string;
  wizardMode?: boolean;
  documentSide?: SdkDocumentSide;
  showDiagnostic?: boolean;
  compressFormat?: SdkCompressFormat;
  jpgQuality?: number;
  showPreviousTip?: boolean;
  vibrationEnabled?: boolean;
}
```

### Configuración avanzada del componente

A continuación se detallan todos los campos que forman parte de esta clase.

{% content-ref url="/pages/4rojYcN122t2mIdLaHZi" %}
[SelphID Configuración](/sdks/sdk-mobile/framework-plugins/extras/selphid/selphid-configuracion.md)
{% endcontent-ref %}

***

## Recepción del resultado <a href="#id-6-recepcion-del-resultado" id="id-6-recepcion-del-resultado"></a>

El lanzamiento devolverá la información en formato ***SelphidResult***. Pudiendo diferenciarse entre un lanzamiento correcto y uno incorrecto:

```typescript
export interface SelphidResult 
{
    finishStatus: number;
    finishStatusDescription: string;
    errorType: string;
    errorMessage?: string;
    frontDocumentImage?: string;
    backDocumentImage?: string;
    faceImage?: string;
    signatureImage?: string;
    fingerprintImage?: string;
    documentData?: string;
    tokenFrontDocument?: string;
    tokenBackDocument?: string;
    tokenFaceImage?: string;
    tokenOCR?: string;
    documentCaptured?: string;
    captureProgress: number;
    matchingSidesScore: number;
    rawFrontDocument?: string;
    rawBackDocument?: string;
    tokenRawFrontDocument?: string;
    tokenRawBackDocument?: string;
    lastActionBeforeCapture?: string;
}
```

### Configuración avanzada del componente

A continuación se detallan todos los campos que forman parte de esta clase.

{% content-ref url="/pages/p4OH5L15yiLpD3JANudF" %}
[Selphid Resultado](/sdks/sdk-mobile/framework-plugins/extras/selphid/selphid-resultado.md)
{% endcontent-ref %}

## Personalización del componente <a href="#id-8-personalizacion-del-componente" id="id-8-personalizacion-del-componente"></a>

Además de los cambios que se pueden realizar a nivel de SDK (los cuales se explican en el documento de [Ajustes avanzados](#id-1-introduccion)), este componente en concreto permite su propia personalización.

{% content-ref url="/pages/fXdp5x6tOufH4uProkFy" %}
[Selphid - Personalización del Componente](/sdks/sdk-mobile/framework-plugins/extras/selphid/selphid-personalizacion-del-componente.md)
{% endcontent-ref %}