DocumentDetector - Flutter Plugin #

Plugin que chama os SDKs nativos em Android e iOS. Caso tenha alguma dúvida, envie um email para o nosso Head of Mobile

Atualmente, os documentos suportados são RG, CNH, RNE, CRLV, CTPS, Passaporte. Caso tenha alguma sugestão de outro documento, contate-nos!

Políticas de privacidade e termos e condições de uso #

Ao utilizar nosso plugin, certifique-se que você concorda com nossas Políticas de privacidade e nossos Termos e condições de uso.

Pré requisitos #

Caso você utilize Dart em uma versão abaixo de 2.12, confira a versão compatível aqui.

Configurações #

Android #

No arquivo ROOT_PROJECT/android/app/build.gradle, adicione:

android {

    ...

    dataBinding.enabled = true

    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }

    aaptOptions {
        noCompress "tflite"
    }
}

iOS #

No arquivo ROOT_PROJECT/ios/Podfile, adicione no final do arquivo:

source 'https://github.com/combateafraude/iOS.git'
source 'https://cdn.cocoapods.org/' # ou 'https://github.com/CocoaPods/Specs' se o CDN estiver fora do ar

Por último, adicione as permissões no arquivo ROOT_PROJECT/ios/Runner/Info.plist:

<key>NSCameraUsageDescription</key>
<string>To read the documents</string>

// Obrigatória somente para o fluxo de upload de documento
<key>NSPhotoLibraryUsageDescription</key>
	<string>To select images</string>

Para habilitar texto e voz em Português, em seu projeto, no diretório ROOTPROJECT/ios, abra o arquivo .xcworkspace no Xcode e adicione em Project > Info > Localizations o idioma Portuguese (Brazil).

Flutter #

Adicione o plugin no seu arquivo ROOT_PROJECT/pubspec.yaml:

dependencies:  
  document_detector:
    git:
      url: https://github.com/combateafraude/Flutter.git
      ref: document-detector-v5.23.0

Desativando validações de segurança para teste #

Estamos constantemente realizando ações para tornar o produto cada vez mais seguro, mitigando uma série de ataques observados ao processo de captura e, consequentemente, reduzindo o maior número de possíveis fraudes de identidade. O SDK possui alguns bloqueios que podem impedir a execução em certos contextos. Para desabilitá-los, você pode utilizar os métodos conforme o exemplo abaixo:

DocumentDetectorAndroidSettings androidSettings =
        DocumentDetectorAndroidSettings(
          emulatorSettings: true,
          rootSettings: true,
          useDeveloperMode: true,
          useAdb: true,
          useDebug: true,
        );

documentDetector.setAndroidSettings(androidSettings);

Atenção! Desabilitar as validações de segurança são recomendadas apenas para ambiente de testes. Para publicação do seu aplicativo em produção, recomendamos utilizar as configurações padrão.

Utilização #

DocumentDetector documentDetector = new DocumentDetector(mobileToken: mobileToken);
documentDetector.setDocumentFlow(List<DocumentDetectorStep> documentSteps);

// Outros parâmetros de customização

DocumentDetectorResult documentDetectorResult = await documentDetector.start();

if (documentDetectorResult is DocumentDetectorSuccess) {
  // O SDK foi encerrado com sucesso e as fotos dos documentos foram capturadas
} else if (documentDetectorResult is DocumentDetectorFailure) {
  // O SDK foi encerrado devido à alguma falha e as fotos dos documentos não foram capturadas
} else {
  // O usuário simplesmente fechou o SDK, sem nenhum resultado
}

Customizações gerais #

| Exemplo de uso |

ShowPreview showPreview = new ShowPreview(
        show: true,
        title: "A foto ficou boa?",
        subtitle: "Veja se a foto está nítida",
        confirmLabel: "Sim, ficou boa!",
        retryLabel: "Tirar novamente");

documentDetector.setShowPreview(showPreview);

 MessageSettings messageSettings = new MessageSettings(
      fitTheDocumentMessageResIdName: "Mensagem de exemplo",
      holdItMessageResIdName:"Mensagem de exemplo",
      verifyingQualityMessageResIdName: "Mensagem de exemplo"
      lowQualityDocumentMessageResIdName:"Mensagem de exemplo" ,
      uploadingImageMessageResIdName:"Mensagem de exemplo",
      openDocumentWrongMessage: "Mensagem de exemplo",
      showOpenDocumentMessage: true);
documentDetector.setMessageSettings(messageSettings);

Android

iOS

Coletando o resultado #

O objeto de retorno do DocumentDetector é do tipo abstrato DocumentDetectorResult. Ele pode ser uma instância de DocumentDetectorSuccess, DocumentDtetectorFailure ou DocumentDetectorClosed.

DocumentDetectorSuccess

Capture

DocumentDtetectorFailure

Os tipos de falha existentes são:

• InvalidTokenReason: quando o token informado é inválido. Não deve ocorrer em um ambiente de produção;
• PermissionReason: quando alguma permissão obrigatória não foi concedida pelo usuário. Só ocorrerá em um ambiente de produção se o seu app não solicitar ao seu usuário ou o mesmo desabilitar manualmente antes de iniciar;
• NetworkReason: falha de conexão com o servidor. Ocorrerá em produção se o dispositivo do usuário estiver sem internet;
• ServerReason: falha em alguma requisição com nossos servidores. Ocorrerá em produção somente no caso de uma falha nossa;
• SecurityReason: quando o dispositivo não é seguro para executar o SDK. Se esta falha ocorrer, avise-nos;
• StorageReason: quando o dispositivo não possui espaço suficiente para a captura de alguma foto. Pode ocorrer em produção;
• LibraryReason: quando alguma falha interna impossibilitou a execução do SDK. Pode ocorrer devico à erros de configuração do projeto, não deve ocorrer em produção;

Customizando view iOS #

Para customização iOS, é necessário que os plugins Flutter estejam adicionados localmente no projeto. A customizção é realizada nativamente com a abordagem ViewCode.

Clique aqui e acesse um exemplo com um guia para utilização desse recurso.