> 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/video-id.md).

# Videoidentificación - VideoID

## Dependencias

### React Native:

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

### Android - Gradle:

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

### iOS - Cocoapods:

```swift
s.dependency 'FPHISDKVideoIDomponent', '~> $version'
```

## Método startVideoIdComponent <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 del Componente:

```dart
Future<Map> startVideoIdComponent({required VideoIdConfiguration widgetConfigurationJSON})
{
  return FphiSdkmobileVideoidPlatform.instance.startVideoIdComponent(
      widgetConfigurationJSON: widgetConfigurationJSON
  );
}
```

## 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 ***VideoIdConfiguration*** que será la configuración del controlador del componente.

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

```typescript
export interface VideoIdConfiguration {
  mode?: VideoMode;
  showTutorial?: boolean;
  autoFaceDetection?: boolean;
  url?: string;
  apiKey?: string;
  tenantId?: string;
  timeoutServerConnection?: number;
  sectionTime?: number;
  vibrationEnabled?: boolean;
  timeoutFaceDetection?: number;
  ocrValidations?: string[];
  countryFilter?: string[];
  documentFilter?: string[];
  sectionTimeout?: number;
  cameraPreferred?: CameraPreferred;
  maxRetries?: number;
  speechText?: string;
  debug?: boolean;
}
```

{% content-ref url="/pages/uQTITr1yAOYjJFzojInZ" %}
[Video Id](/sdks/sdk-mobile/framework-plugins/extras/video-id.md)
{% endcontent-ref %}

### Configuración avanzada del componente

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

## 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 ***VideoIdResult***. Pudiendo diferenciarse entre un lanzamiento correcto y uno incorrecto:

```typescript
export interface VideoIdResult {
  finishStatus: number;
  finishStatusDescription?: string;
  errorType: string;
  errorMessage?: string;
  faceImage?: string;
  faceImageTokenized?: string;
  documentFaceImageTokenized?: string;
  matchingSidesScore?: number;
  speechText?: string;
  documentType?: string;
  personalData?: any;
  frontDocumentData?: any;
  backDocumentData?: any;
  ocrMap?: any;
  ocrDiagnostic?: any;
}
```

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

{% content-ref url="/pages/1nJjjGavGWsAq6dpXyWL" %}
[Video Id Resultado](/sdks/sdk-mobile/framework-plugins/extras/video-id/video-id-resultado.md)
{% endcontent-ref %}