> 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/capacitor/componentes/captura-de-documentos.md).

# Captura de documentos - SelphID

A captura de documentos é feita com o ***SelphID Plugin***.

Este componente é responsável por realizar capturas de documentos de identidade e pela análise dos dados obtidos. Seus principais processos são:

* Gerenciamento interno de câmeras e permissões.
* Assistente nos processos de captura da parte frontal e traseira do documento.
* Extração das informações contidas no documento.
* Obtenção das imagens do verso e do reverso do documento, assim como outras imagens incluídas no documento: rosto do usuário, assinatura do usuário,...
* Alto nível de configuração: diferentes países, idiomas, tipos de documentos...

***

## Dependências <a href="#id-2-dependencia" id="id-2-dependencia"></a>

### Capacitor:

```bash
npm install @facephi/sdk-selphid-capacitor@<versão>
npm run build
npx cap sync
```

### Android - Gradle:

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

### iOS - CocoaPods:

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

## Métodos disponíveis

Este componente contém vários métodos que executam 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>Descrição</strong></td></tr><tr><td>launchSelphID</td><td>Controlador principal de captura de documentos</td></tr></tbody></table>

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

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

Lançamento da captura facial:

```javascript
startCapture(configuration: SelphIDConfiguration): Promise<SelphIDResult>;
```

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

Para lançar o componente atual, será necessário criar um objeto ***SelphIDConfiguration*** que será a configuração do controlador do componente.

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

```typescript
export interface SelphIDConfiguration 
{
    wizardMode?: boolean;
    documentSide: SelphIDDocumentSide;
    resourcesPath: string;
    debug?: boolean;
    showResultAfterCapture?: boolean;
    showTutorial?: boolean;
    tutorialOnly?: boolean;
    scanMode?: SelphIDScanMode;
    specificData?: string;
    fullscreen?: number;
    tokenImageQuality?: number;
    documentType?: SelphIDDocumentType;
    timeout?: SelphIDTimeout;
    tokenPrevCaptureData?: string;
    generateRawImages?: boolean;
    imageQuality?: number;
    compressFormat?: SelphIDCompressFormat;
    documentModels?: string;
    params?: any;
    showDiagnostic?: boolean;
    cameraId?: number;
    translationsContent?: string;
    viewsContent?: string;
    showPreviousTip?: boolean;
    vibrationEnabled?: boolean;
}
```

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

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

{% content-ref url="/pages/112cdfd35f0e905e281b3edb8bef514069d4b7ed" %}
[Configuração do SelphID](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/selphid/selphid-configuracion.md)
{% endcontent-ref %}

***

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

A inicialização retornará as informações no formato ***SelphIDResult***. Podendo diferenciar entre uma inicialização correta e uma incorreta:

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

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

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

{% content-ref url="/pages/f63bd62ead964aca7a05e1b9066b9f255fae7301" %}
[Resultado do SelphID](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/selphid/selphid-resultado.md)
{% endcontent-ref %}

## Personalização do componente <a href="#id-8-personalizacion-del-componente" id="id-8-personalizacion-del-componente"></a>

Além das alterações que podem ser feitas no nível do SDK (as quais são explicadas no documento de [Configurações avançadas](#id-1-introduccion)), este componente específico permite sua própria personalização.

{% content-ref url="/pages/bae8ca88cbe0979ff8433d5a998ede635fab265b" %}
[SelphID - Personalização do Componente](/docs.facephi-pt-br/sdks/sdk-mobile/framework-plugins/extras/selphid/selphid-personalizacion-del-componente.md)
{% endcontent-ref %}