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

# Video Identification - VideoID

## Dependencies

### React Native:

```swift
npm install @facephi/sdk-videoid-react-native@<Version>
```

### Android - Gradle:

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

### iOS - CocoaPods:

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

## Method startVideoIdComponent <a href="#id-4-lanzamiento-simplificado" id="id-4-lanzamiento-simplificado"></a>

Once the SDK has been started and a new operation has been created, the component can be launched. Any of its controllers can be used to execute its functionality.

Component Launch:

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

## Basic configuration <a href="#id-5-configuracion-basica" id="id-5-configuracion-basica"></a>

To launch the current component, an object ***VideoIdConfiguration*** must be created, which will be the configuration of the component controller.

The basic configuration needed for this is as follows:

```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/f32a89f0160a7d21923adaa415f99743d73475ea" %}
[Video ID](/docs.facephi-en/sdks/sdk-mobile/framework-plugins/extras/video-id.md)
{% endcontent-ref %}

### Advanced component configuration

Below are all the fields that are part of this class.

## Result reception <a href="#id-6-recepcion-del-resultado" id="id-6-recepcion-del-resultado"></a>

The launch will return the information in the format ***VideoIdResult***. It being possible to distinguish between a successful launch and an unsuccessful one:

```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;
}
```

Below are all the fields that are part of this class.

{% content-ref url="/pages/5d34538ba4a4a77ada0d706ae4f881335105aa15" %}
[Video ID Result](/docs.facephi-en/sdks/sdk-mobile/framework-plugins/extras/video-id/video-id-resultado.md)
{% endcontent-ref %}