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

# Captura de documentos - SelphID

A captura de documentos é realizada 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:

* Gestão interna 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 dorso e do verso do documento, assim como de 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>

### React:

```swift
npm install @facephi/sdk-selphid-react-native@<versão>
```

### 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 selphid <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 lançar o componente. Será possível fazer uso de qualquer um de seus controladores para executar sua funcionalidade.

Lançamento da Captura Facial:

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

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

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

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

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

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

A seguir, estã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 um lançamento correto e um incorreto:

```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, estã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))

{% 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 %}