> 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/android-sdk/componentes-modulos/captura-de-nfc.md).

# Captura de NFC

## Introdução <a href="#id-1-introduccion" id="id-1-introduccion"></a>

A leitura NFC é realizada com o ***NFC Component***.

Esse componente é responsável por realizar a leitura NFC dos documentos de identidade e passaportes. Seus principais processos são:

* Gerenciamento interno do sensor NFC.
* Gerenciamento de permissões.
* Análise do documento.
* Análise do progresso.
* Assistente nos processos de leitura.
* Retorno de todas as informações que puderem ser lidas
* Retorno de imagens quando estiverem disponíveis para leitura

Na seção [Lançamento simplificado](https://docs.facephi.com/docs.facephi-pt-br/sdks/sdk-mobile/android-sdk/inicializacion/lanzamiento-simplificado.md) são detalhadas as etapas necessárias para a integração básica do SDK. Nesta seção, são adicionadas as informações para o lançamento desse componente.

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

A dependência específica do componente é:

```kts
implementation "com.facephi.androidsdk:nfc_component:$sdk_nfc_component_version"{
      exclude group : "org.bouncycastle", module : "bcprov-jdk15on"
      exclude group : "org.bouncycastle", module : "jetified-bcprov-jdk15on-1.68"
  }
```

Além disso, será necessário adicionar ao Gradle:

```kts
android {
  ...
 packaging {
      resources {
          pickFirsts.add("META-INF/versions/9/OSGI-INF/MANIFEST.MF")
      }
  }
}
```

## Controladores disponíveis

| **Controlador** | **Descrição**                        |
| --------------- | ------------------------------------ |
| NfcController   | Controlador principal de leitura NFC |

## Lançamento simplificado <a href="#id-4-lanzamiento-simplificado" id="id-4-lanzamiento-simplificado"></a>

Depois que o SDK for iniciado e uma nova operação for criada, será possível iniciar o componente. Qualquer um de seus controladores poderá ser usado para executar suas funcionalidades.

Lançamento da captura:

<pre class="language-kotlin"><code class="lang-kotlin"><strong>val response = SDKController.launch(
</strong><strong>    NfcController(
</strong>        componentData = NfcConfigurationData(...),
        state = { state ->
            Napier.d("NFC: State: ${state.name}")
        },
        debugLogs = {
            Napier.d("NFC Logs: $it")
        }
    )
)
when (response) {
    is SdkResult.Error -> Napier.d("NFC: ERROR - ${response.error.name}")
    is SdkResult.Success -> response.data
}
</code></pre>

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

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

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

```kotlin
NfcConfigurationData(
    documentNumber = NFC_SUPPORT_NUMBER, // Num soport.
    birthDate = NFC_BIRTH_DATE, // "dd/MM/yyyy"
    expirationDate = NFC_EXPIRATION_DATE, // "dd/MM/yyyy",
)
```

Os dados necessários são os do documento que será capturado.

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

A chamada retornará as informações no formato SdkResult. É possível diferenciar entre uma chamada bem-sucedida e uma malsucedida:

```kotlin
when (response) {
    is SdkResult.Error -> Napier.d("ERROR - ${response.error}")
    is SdkResult.Success -> response.data
}
```

### Recebimento de erros <a href="#id-61-recepcion-de-errores" id="id-61-recepcion-de-errores"></a>

Os erros serão retornados como um objeto 'NfcError'.

Lista de erros:

* `ACTIVITY_RESULT_MSG_ERROR` (`NFC_610`): Erro na mensagem de resultado da atividade.
* `APPLICATION_CONTEXT_ERROR` (`NFC_611`): O contexto de aplicativo necessário é nulo.
* `CANCEL_BY_USER` (`NFC_000`): O usuário cancelou o processo.
* `CANCEL_LAUNCH` (`NFC_007`): Foi realizado um cancelamento geral do SDK.
* `COMPONENT_LICENSE_ERROR` (`NFC_002`): A licença do componente está incorreta.
* `EMPTY_LICENSE` (`NFC_003`): A string da licença está vazia.
* `EXTRACT_DATA_ERROR` (`NFC_600`): Erro nos dados extraídos.
* `FETCH_DATA_ERROR` (`NFC_601`): Erro ao obter o resultado.
* `FLOW_ERROR` (`NFC_617`): Erro no processo de flow.
* `FLOW_TRACKING_ERROR` (`NFC_615`): Erro no tracking do flow.
* `FLOW_VIDEO_RECORDING_ERROR` (`NFC_613`): Erro na gravação de vídeo do flow.
* `INITIALIZATION_ERROR` (`NFC_004`): Erro de inicialização.
* `INTERNAL_ERROR` (`NFC_616`): Erro interno.
* `LAST_COMMAND_EXPECTED` (`NFC_602`): Erro no comando de finalização
* `MANAGER_NOT_INITIALIZED` (`NFC_612`): Os gerenciadores são nulos.
* `NO_DATA_ERROR` (`NFC_005`): Os dados de entrada são nulos ou nenhum resultado da leitura foi recebido.
* `NFC_ERROR` (`NFC_603`): Erro geral
* `NFC_ERROR_DATA` (`NFC_604`): Erro nos dados de entrada
* `NFC_ERROR_DISABLED` (`NFC_605`): NFC desativado
* `NFC_ERROR_ILLEGAL_ARGUMENT` (`NFC_606`): NFC com uma tag incorreta
* `NFC_ERROR_IO` (`NFC_607`): Erro de entrada/saída
* `NFC_ERROR_NOT_SUPPORTED` (`NFC_608`): NFC não suportado
* `NFC_ERROR_TAG_LOST` (`NFC_609`): Conexão perdida
* `OPERATION_NOT_CREATED` (`NFC_006`): Não há nenhuma operação em andamento.
* `TIMEOUT` (`NFC_001`): Timeout no processo.
* `TRACKING_STEP_ERROR` (`NFC_614`): Erro no Tracking de uma etapa do processo.

### Recebimento do resultado correto - *data* <a href="#id-62-recepcion-del-resultado-correcto-data" id="id-62-recepcion-del-resultado-correcto-data"></a>

Na parte de SdkResult.Success - *data*, teremos a classe *NfcResult*.

O resultado retorna as imagens no formato **SdkImage**, é possível extrair o bitmap acessando *image.bitmap*. Para converter para base64, é possível usar a função:

`Base64.encodeToString(this.toByteArray(), Base64.NO_WRAP)`

{% hint style="info" %}
Os campos criptografados no resultado são incluídos a partir da versão 2.6.0
{% endhint %}

Os campos retornados no resultado são os seguintes:

**nfcRawData**

Informações obtidas por cada tipo de dado em formato bruto, ordenadas por:

* comSdkModel
* dg1SdkModel
* dg2SdkModel
* dg3SdkModel
* dg4SdkModel
* dg5SdkModel
* dg7SdkModel
* dg11SdkModel
* dg12SdkModel
* dg13SdkModel
* dg14SdkModel
* dg15SdkModel

**nfcDocumentInformation**

Informações obtidas do documento, ordenadas por:

* documentNumber
* expirationDate
* issuer
* mrzString
* type

**nfcPersonalInformation**

Informações obtidas do documento, ordenadas por:

* address
* birthdate
* city
* gender
* name
* nationality
* personalNumber
* placeOfBirth
* surname

**nfcImages**

Informações sobre as imagens obtidas do documento, ordenadas por:

* facialImage
* signatureImage
* tokenFacialImage
* tokenSignatureImage

**nfcSecurityData**

Informações sobre os dados de segurança do documento, ordenadas por:

* dataGroupsHashes
* dataGroupsRead
* documentSigningCertificateData
* issuerSigningCertificateData
* ldsVersion

**nfcValidations**

Informações sobre as validações do documento, ordenadas por:

* accessType
* activeAuthenticationSupported
* activeAuthenticationValidation
* chipAuthenticationSupported
* chipAuthenticationValidation
* dataGroupsHashesValidation
* documentSigningValidation
* issuerSigningValidation

**tokenOCR**

Dados do OCR criptografados

## Informações avançadas <a href="#id-7-informacion-avanzada" id="id-7-informacion-avanzada"></a>

Esta seção amplia as informações sobre o componente.

### Configuração avançada do componente <a href="#id-71-configuracion-avanzada-del-componente" id="id-71-configuracion-avanzada-del-componente"></a>

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

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

**documentNumber**

Indica o número do documento ou o número de suporte, dependendo do documento cuja leitura será realizada.

Este campo é obrigatório.

**birthDate**

Indica a data de nascimento que aparece no documento ("dd/MM/yyyy").

Este campo é obrigatório.

**expirationDate**

Indica a data de expiração que aparece no documento ("dd/MM/yyyy").

Este campo é obrigatório.

**extractionTimeout**

Define o tempo máximo para realizar a leitura, em milissegundos. O padrão é 60000.

**showTutorial**

Indica se o componente ativa a tela de tutorial. Nessa tela, é explicado de forma intuitiva como fazer a captura. O padrão é true.

**vibrationEnabled**

Indica se deseja receber um feedback de vibração ao final do processo. O padrão é true.

**skipPACE**

Indica que se deseja realizar apenas a leitura BAC de NFC. É uma leitura com informações mais simples e rápida, que permite a leitura de uma variedade maior de documentos. O padrão é false.

**showDiagnostic**

Exibe telas de diagnóstico ao final do processo. O padrão é true.

**extractFacialImage**

Indica se deseja extrair a imagem do rosto. O padrão é true.

**extractSignatureImage**

Indica se deseja extrair a imagem da assinatura. O padrão é false.

**documentType**

Campo usado para alterar a tela do tutorial e exibir os diferentes documentos. É opcional (o padrão é null) e seus valores possíveis são:

* NfcDocumentType.ID\_CARD
* NfcDocumentType.PASSPORT
* NfcDocumentType.FOREIGN\_CARD

**showPreviousTip**

Exibe uma tela antes de iniciar a captura, com informações sobre o processo a ser realizado e um botão para iniciá-lo. O padrão é true.

**readingProgressStyle**

Alteração do estilo na tela de leitura do documento (o padrão é ReadingProgressStyle.DOTS):

* ReadingProgressStyle.DOTS: O progresso é indicado visualmente por pontos
* ReadingProgressStyle.PERCENTAGE: O progresso é exibido em porcentagem

***

## 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 (explicadas no documento de [Personalização do SDK](https://docs.facephi.com/docs.facephi-pt-br/sdks/sdk-mobile/android-sdk/personalizacion.md)), este componente, especificamente, permite modificar sua interface.

### Textos <a href="#id-81-textos" id="id-81-textos"></a>

Os textos podem ser personalizados adicionando um arquivo XML de recursos ao aplicativo cliente e substituindo os valores padrão.

```kotlin
<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="nfc_widget_previous_tip_title_passport">NFC Reader</string>
    <string name="nfc_widget_previous_tip_title_id">NFC Reader</string>
    <string name="nfc_widget_previous_tip_description">&lt;b&gt;Attach&lt;/b&gt; the document to the back of your device.</string>
    <string name="nfc_widget_start_button">Iniciar</string>
    <string name="nfc_widget_tutorial_button">Confira estas dicas</string>
    <string name="nfc_widget_close_button">Fechar</string>
    <string name="nfc_widget_info_button">Mais informações</string>
    <string name="nfc_widget_previous_tip_animation_desc">Dicas anteriores de NFC</string>
    <string name="nfc_widget_mandatory_tutorial_title">Leitor NFC</string>
    <string name="nfc_widget_tutorial_tip_1">Quando aproximamos um cartão de um sensor, ocorre uma troca de informações chamada NFC.</string>
    <string name="nfc_widget_tutorial_tip_2">No seu celular, o sensor fica na área marcada. É nela que você deve aproximar seu documento.</string>
    <string name="nfc_widget_tutorial_tip_3_passport">Mantenha o passaporte &lt;b&gt;fechado&lt;/b&gt; para fazer a leitura.</string>
    <string name="nfc_widget_tutorial_tip_3_id">Para uma leitura melhor, retire a capa do seu celular.</string>
    <string name="nfc_widget_ready_to_scan">Pronto para digitalizar</string>
    <string name="nfc_widget_reading_device">Lendo o dispositivo</string>
    <string name="nfc_widget_start_message">Aproxime o chip do seu celular.\nQuando ele for detectado, mantenha-o parado.</string>
    <string name="nfc_widget_reading_message">Mantenha-o nessa posição.</string>
    <string name="nfc_widget_reading_document_message">Extraindo os dados do documento.</string>
    <string name="nfc_widget_reading_images_message">Extraindo as imagens.</string>
    <string name="nfc_widget_close_alt">Fechar processo</string>
    <string name="nfc_widget_reading_title">Lendo o chip NFC</string>
    <string name="nfc_widget_reading_animation_desc">Animação de leitura NFC</string>
    <string name="nfc_widget_cancel_button">Cancelar</string>
    <string name="nfc_widget_success_title">Leitura concluída</string>
    <string name="nfc_widget_success_document_prefix">Documento:</string>
    <string name="nfc_widget_success_animation_desc">Leitura concluída</string>
    <string name="nfc_widget_error_title">Leitura incompleta</string>
    <string name="nfc_widget_error_animation_desc">Leitura cancelada</string>
    <string name="nfc_widget_retry_button">Tentar novamente</string>
    <string name="nfc_widget_close_action">Fechar</string>
    <string name="nfc_widget_cancelled_title">Fluxo NFC cancelado</string>
    <string name="nfc_widget_cancelled_desc">Feche a tela para continuar.</string>
    <string name="nfc_widget_cancelled_animation_desc">Fluxo NFC cancelado</string>
    <string name="nfc_widget_timeout_title">Siga as instruções</string>
    <string name="nfc_widget_timeout_desc">Aproxime o documento &lt;b&gt;depois&lt;/b&gt; de clicar no &lt;b&gt;botão Iniciar.&lt;/b&gt;</string>
    <string name="nfc_widget_tag_lost_title">Leitura não concluída</string>
    <string name="nfc_widget_tag_lost_desc">Mantenha-o nessa posição até o fim da leitura</string>
    <string name="nfc_widget_data_error_title">Não foi possível ler o documento</string>
    <string name="nfc_widget_data_error_desc">Revise os dados informados</string>
    <string name="nfc_widget_internal_error_title">Ocorreu um problema técnico</string>
    <string name="nfc_widget_internal_error_desc">Pedimos desculpas. Não foi possível fazer a captura</string>
    <string name="nfc_widget_state_waiting_for_tag">Deslize o documento até que o sensor o detecte.</string>
    <string name="nfc_widget_state_preparing">Preparando a leitura do chip...</string>
    <string name="nfc_widget_state_secure_access">Validando o acesso seguro ao documento...</string>
    <string name="nfc_widget_state_reading_data">Lendo os dados do documento...</string>
    <string name="nfc_widget_state_reading_images">Lendo as imagens do documento...</string>
    <string name="nfc_widget_state_io_error">Foi detectado um problema de comunicação com o NFC.</string>
    <string name="nfc_widget_state_finished">Leitura concluída.</string>
</resources>

```

### Animações <a href="#id-82-animaciones" id="id-82-animaciones"></a>

Se quiser modificar as animações (lottie) do SDK, inclua na pasta res/raw/ do aplicativo animações com o mesmo nome.

```
nfc_anim_reader.json
nfc_anim_tuto_1.json
nfc_anim_tuto_2.json
nfc_anim_tuto_3.json
nfc_anim_tuto_3_pass.json
nfc_anim_tuto_id.json
nfc_anim_tuto_passport.json
```
