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

# Videoidentificação - VideoID

## Dependências

### Cordova:

```swift
cordova plugin add @facephi/sdk-videoid-cordova@<Versão>
```

### 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>

Uma vez iniciado o SDK e criada uma nova operação, será possível iniciar o componente. Será possível usar qualquer um de seus controladores para executar sua funcionalidade.

Lançamento do Componente:

```js
exports.launchVideoId = function (cfg)
{
    return new Promise((resolve, reject) => {
        config = [];
        try {
            config = [{ "config": cfg }];
        }
        catch (e) {
            console.log(e);
        }

        exec(resolve, reject, 'SdkVideoId', 'videoId', config);
    });
};
```

## Configuração básica <a href="#id-5-configuracion-basica" id="id-5-configuracion-basica"></a>

Para lançar o componente atual, deverá ser criado um objeto ***VideoIdConfiguration*** que será a configuração do controlador do componente.

A configuração básica necessária é a seguinte:

```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/a690a81822613189fa212dfbaba59494f445c7bc" %}
[Configuração do Video ID](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/video-id/video-id-configuracion.md)
{% endcontent-ref %}

### Configuração avançada do componente

A seguir, são detalhados todos os campos que fazem parte desta classe.

## Recebimento do resultado <a href="#id-6-recepcion-del-resultado" id="id-6-recepcion-del-resultado"></a>

O lançamento retornará as informações no formato ***VideoIdResult***. Podendo diferenciar-se entre um lançamento correto e um incorreto:

```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 seguir, são detalhados todos os campos que fazem parte desta classe.

{% content-ref url="/pages/e0efc7195789c61ebf795e64f85e4cf98a6a4e29" %}
[Resultado do Video ID](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/video-id/video-id-resultado.md)
{% endcontent-ref %}