Objeto UnicoError​

Este objeto é retornado sempre que ocorre um erro no SDK Flutter.

Métodos disponíveis

É disponibilizado a seguir a lista de possíveis códigos de erro do SDK Flutter:

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

O SDK Android permite que algumas personalizações sejam feitas. Abaixo veja todas as personalizações possíveis para este SDK.

Personalizar idioma

É possível configurar a experiência das mensagens informativas dos frames de captura alterando seu idioma. Utilize o enumerado LocaleTypes que contém os seguintes valores:

• LocaleTypes.PT_BR: para Português(Brasil);

• LocaleTypes.ES_MX: para Espanhol(México);

• LocaleTypes.ES_ES: para Espanhol(Espanha);

• LocaleTypes.EN_US: para Inglês(EUA).

Veja como implementar no exemplo abaixo:

unicoCheck.setLocale(LocaleTypes.EN_US);

Personalizar experiência do processo de captura

Esta é uma etapa opcional, porém muito recomendada para que o processo de captura tenha a identidade visual da sua empresa.

É possível customizar alguns objetos do frame de acordo com o modo de câmera utilizado, através do método setTheme().

Todos os métodos estão disponíveis abaixo:

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Este guia foi elaborado para ajudá-lo a implementar o SDK Flutter de forma rápida e fácil. Abaixo veja o passo a passo de todo o processo de integração. Após isso, caso deseje personalizar a experiência, não deixe de ver a seção Personalização Flutter.

Frames de documentos disponíveis

Neste modo de câmera, existe um frame de captura para auxiliar o usuário a posicionar o documento corretamente. Após posicionar o documento corretamente, o usuário deve clicar no botão para realizar a captura da foto do documento.

Neste modo de câmera é possivel capturar os documentos:

• CPF: Captura da frente do CPF;

• CNH: Captura da CNH aberta;

• CNH frente: Captura da frente da CNH;

• CNH verso: Captura do verso da CNH;

• RG frente: Captura da frente do RG;

• RG verso: Captura do verso do RG;

• Outros: Captura de qualquer outro documento.

Inicializar o SDK

Para iniciar, crie uma instância do builder (gerado através da interface UnicoCheckBuilder, fornecendo como parâmetro o contexto em questão e a implementação da classe UnicoListener.

A implementação dessa classe é bem simples e pode ser feita com poucas linhas de código. Tudo que precisa fazer é sobrescrever os métodos de callback com as lógicas de negócio de sua aplicação.

class _MyHomePageState extends State<MyHomePage> implements UnicoListener {

    late UnicoCheckBuilder _unicoCheck;

    /// Unico callbacks
      @override
      void onErrorUnico(UnicoError error) {}

      @override
      void onUserClosedCameraManually() {}

      @override
      void onSystemChangedTypeCameraTimeoutFaceInference() {}

      @override
      void onSystemClosedCameraTimeoutSession() {}

      /// Document callbacks
      @override
      void onSuccessDocument(ResultCamera resultCamera) { }

      @override
      void onErrorDocument(UnicoError error) { }

}

Implementar as funções de callback

Note que, conforme o exemplo anterior, o trabalho de implementação da classe UnicoListener é, em grande parte, a configuração dos métodos de callback. Cada método é chamado em uma situação específica de retorno do SDK.

Basta sobrescrever os métodos exemplificados no passo anterior com as lógicas de negócio de sua aplicação:

Implementar listeners para eventos da câmera

O método de abertura da câmera precisa saber o que fazer ao conseguir capturar uma imagem ou ao ter algum erro no processo. É informado "o que fazer" ao método de abertura da câmera através da implantação de listeners que são chamados em situações de sucesso ou erro.

Através da implementação dos listeners, você pode especificar o que acontece em seu App em situações de erro (método onErrorDocument) ou sucesso (método onSuccessDocument) na captura de imagens.

Método onSucessDocument

Ao efetuar uma captura de imagem com sucesso, este método é invocado e retorna um objeto do tipo ResultCamera que é utilizado posteriormente na chamada das APIs REST:

public void onSuccessDocument(ResultCamera resultCamera) { }

O objeto ResultCamera retorna 2 atributos: base64 e encrypted:

• O atributo base64 pode ser utilizado se quiser exibir uma prévia da imagem em seu app;

• Tanto o atributo encrypted quanto o atributo base64 podem ser enviados na chamada das APIs REST do by Client.

Método onErrorDocument

Ao ocorrer algum erro na captura de imagem, este método é invocado e retorna um objeto do tipo UnicoError:

public void onErrorDocument(UnicoError error) { }

Preparar e abrir câmera

Para abrir a câmera, o método openCameraDocument() é utilizado. Esse método é disponibilizado através do objeto gerado com uma instancia da classe UnicoCheck.

Este método recebe os seguintes parâmetros:

• Arquivo JSON com as credenciais, gerado no passo de configurar credenciais;

• Os listeners configurados acima;

• Tipo de documento a ser capturado, sendo eles:

Exemplo para captura de CNH:

 _unicoCheck.build().openCameraDocument(
        jsonFileName: androidJsonFileName,
        documentType: DocumentType.CNH,
        listener: this);

Realize um requisição POST na API REST do by Client

A captura das imagens é apenas a primeira parte da jornada. Após capturar a imagem, é necessário enviar o base64 gerado pelo SDK para as APIs REST do by Client. Saiba mais na seção CreateProcess do by Client.

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Pré-requisitos do ambiente de desenvolvimento

É necessário que seu ambiente de desenvolvimento esteja de acordo com os seguintes pré-requisitos:

Dispositivos compatíveis

Dispositivos iOS:

• iOS: é compatível com quase todos os dispositivos que possuam iOS 11.

Você pode conferir a lista com esses dispositivos nos canais de suporte oficiais da Apple.

Dispositivos Android:

• É compatível com a grande maioria dos dispositivos que possuam Android 5.0 (API de nível 21) ou versões superiores;

A tabela a seguir lista os dispositivos testados em laboratório, além da disponibilidade das extensões do fornecedor/fabricante. Algumas extensões listadas podem estar sujeitas as API ou SKUs específicos do fabricante. Clique abaixo para ver os dispositivos testados:

Instalando o SDK Flutter

Para implementar o SDK Flutter da plataforma Unico IDCloud ao seu aplicativo Flutter, siga o passo a passo listado abaixo:

$ flutter pub add unico_check

dependencies:
  unico_check: ^2.0.2

<key>NSCameraUsageDescription</key>
<string>Camera usage description</string>

import 'package:unico_check/unico_check.dart';

final _configIos = UnicoConfig(
      getBundleIdentifier: "Your BundleIdentifier Ios",
      getHostKey: "Your HostKey Ios"); 

  final _configAndroid = UnicoConfig(
      getBundleIdentifier: "Your BundleIdentifier Android",
      getHostKey: "Your HostKey Android");

  void initUnicoCamera() {
    _unicoCheck = new UnicoCheck(
        listener: this,
        unicoConfigIos: _configIos,
        unicoConfigAndroid: _configAndroid);
  }

  final _configIos = UnicoConfig(
      getProjectNumber: "Your ProjectNumber Ios",
      getProjectId: "Your ProjectId Ios",
      getMobileSdkAppId: "Your MobileSdkAppId Ios",
      getBundleIdentifier: "Your BundleIdentifier Ios",
      getHostInfo: "Your HostInfo Ios",
      getHostKey: "Your HostKey Ios");

  final _configAndroid = UnicoConfig(
      getProjectNumber: "Your ProjectNumber Android",
      getProjectId: "Your ProjectId Android",
      getMobileSdkAppId: "Your MobileSdkAppId Android",
      getBundleIdentifier: "Your BundleIdentifier Android",
      getHostInfo: "Your HostInfo Android",
      getHostKey: "Your HostKey Android");

@override
  void initState() {
    super.initState();
    initUnicoCamera();
    configUnicoCamera();
  }

  void initUnicoCamera() {
    _unicoCheck = new UnicoCheck(
        listener: this,
        unicoConfigIos: _configIos,
        unicoConfigAndroid: _configAndroid);
  }

Pronto. Finalizada a instalação do SDK, siga para a implementação lendo o material Guia de uso e integração a seguir:

Dúvidas?​

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.

Ofuscação de código

O ofuscamento é um processo de transformar o bytecode em uma forma menos legível por humanos, dificultando assim a engenharia reversa.

Esse processo consiste em remover informações relacionadas a depuração como tabelas de variáveis, número de linhas e renomear os pacotes, classes e métodos.

Ao embarcar a SDK Adroid na aplicação podem ocorrer falhas.

Ofuscação via DexGuard

Quando o ofuscamento foi realizado via DexGuard, ao ocorrer a falha utilize as regras:

Ofuscação via ProGuard

Quando o ofuscamento foi realizado via ProGuard, ao ocorrer a falha utilize as regras:

Erro de bitcode na distribuição de aplicativos usando Xcode 16

Após o lançamento da versão oficial do Xcode 16 no dia 17 de setempro de 2024 e com a sua utilização para distribuição de aplicativos na AppStore, verificamos um bloqueio ao utilizar a SDK iOS sinalizando o uso de bitcode em duas dependências internas ao utilizar o Cocoapods como gerenciador de dependencias internas, são elas o DeviceProfiling e UnicoSdkLogger. A fim de não bloquear novos lançamentos é possível aplicar o seguinte passo-a-passo até a sua definitiva correção em uma release futura da SDK iOS:

1. Abrir arquivo Podfile;

2. Inserir as linhas a seguir após comando post_install do |installer| e antes do ultimo end:

   2.1. Caso já haja algum código, insira antes do trecho existente;

   2.2. Caso já faça a remoção do bitcode manualmente, adicionar os caminhos explicitamente citados em framework_paths;

3. Caso não haja o comando post_install do |installer| no arquivo Podfile, inserir-lo confrme a seguir antes do último end:

Versão 4.20.0 - 05/11/2024

• Atualização de sdk nativas:

  • Android versão 5.25.0 .

Versão 4.19.0 - 18/10/2024

• Atualização de sdk nativas:

  • Android versão 5.24.0 ;

  • iOS versão 2.16.4 .

Correção na câmera de documento, onde em alguns cenários ocorria um crash após a captura.

Versão 4.17.0 - 04/10/2024

• Atualização de sdk nativas:

Versão 4.16.0 - 19/09/2024

• Atualização de sdk nativas:

Versão 4.15.0 - 10/09/2024

• Atualização de sdk nativas:

• Atualização de sdk nativas:

Versão 4.13.0 - 22/08/2024

• Agora, os SDKs suportam múltiplos idiomas! Além do português, é possível alternar entre as opções de inglês e espanhol no método setLocale(), oferecendo uma experiência mais personalizada para os usuários final;

• A partir de agora, é possível definir o ambiente da SDK pela própria API pública no método setEnvironment();

• Em casos de dúvidas, contacte o seu CSM.

Versão 4.12.0 - 20/08/2024

• Atualização de sdk nativas:

Versão 4.11.0 - 07/08/2024

• Atualização de sdk nativas:

• Atualização de sdk nativas:

• Atualização de sdk nativas:

• Atualização de sdk nativas:

• Atualização de sdk nativas:

• Atualização de sdk nativas:

• Atualização de sdk nativas:

• Atualização de sdk nativas:

Versão 4.6.0 - 26/04/2024

• Atualização de sdk nativas:

• Atualização de sdk nativas:

Versão 4.5.1 - 02/04/2024

• Atualização de sdk nativas:

• Atualização de sdk nativas:

Versão 4.4.0 - 14/03/2024

• Atualização de sdk nativas:

Versão 4.3.0 - 17/01/2024

• Atualização de sdk nativas:

• Atualização de sdk nativas:

Versão 4.1.0 - 30/10/2023

• Atualização de sdk nativas:

• Atualização de sdk nativas:

• Atualização de sdk nativas:
• Atualização da versão mínima do SDK Dart para >= 2.15.0

• Customização da tela de loading usando a cor do background da captura;

• Atualização de sdk nativas:

• Atualização do server e SDK do Smartlive com interação.

Versão 3.0.7 - 20/04/2023

• Fix: Abertura da câmera com Smartlive com interação;

• Fix: Incompatibilidade durante o build com ofuscação.

Versão 3.0.6 - 21/02/2023

• Fix: Atualização bibliotecas nativas.

Versão 3.0.5 - 13/01/2023

• Fix: Camera traseira.

Versão 3.0.4 - 13/01/2023

• Fix: Erro build não encontrando arquivos.

Versão 3.0.3 - 13/01/2023

• Atualização de sdk nativas:
• Fix: Abertura de câmera ao não permitir o uso da geolocalização.

• Atualização de sdk nativas:
• Fix: Correção no exemplo de RG.

Versão 3.0.1 - 24/09/2022

• Atualização da SDK e server do Smartlive com interação;

• Fix: Correção na dependência do arquivo google-service-json.

• Versão estável do SDK que contém a técnologia de SmartLive com interação.

Versão 3.0.0-beta.1

• Nova versão do SDK que contém a técnologia de SmartLive com interação.

Versão 2.0.2 deprecated

• Maior versão estável do SDK Flutter. Contém apenas captura manual e automática.

Este guia foi elaborado para ajudá-lo a implementar o SDK Flutter de forma rápida e fácil. Abaixo veja o passo a passo de todo o processo de integração. Após isso, caso deseje personalizar a experiência, não deixe de ver a seção .

Inicializar o SDK

Para iniciar, crie uma instância do builder (gerado através da interface UnicoCheckBuilder, fornecendo como parâmetro o contexto e ambiente em questão e a implementação da classe UnicoListener.

A implementação dessa classe é bem simples e pode ser feita com poucas linhas de código. Tudo que precisa fazer é sobrescrever os métodos de callback com as lógicas de negócio de sua aplicação.

Configuração de ambientes

Configure o ambiente que será utilizado na execução da SDK. Utilize o enumerado Environment que contém os seguintes enumerados:

• UnicoEnvironment.PROD: para ambiente de Produção;

• UnicoEnvironment.UAT: para ambiente de Homologação.

Veja como implementar no exemplo abaixo:

Implementar as funções de callback

Note que, conforme o exemplo anterior, o trabalho de implementação da classe UnicoListener é, em grande parte, a configuração dos métodos de callback. Cada método será chamado em uma situação específica de retorno do SDK.

Basta sobrescrever os métodos exemplificados no passo anterior com as lógicas de negócio de sua aplicação:

Configurar modo de câmera

O SDK tem configurado e habilitado por padrão o enquadramento inteligente e a captura automática. Em função disso, deve-se configurar o modo de câmera no seu builder da seguinte forma:

Implementar listeners para eventos da câmera

O método de abertura da câmera precisa saber o que fazer ao conseguir capturar uma imagem ou ao ter algum erro no processo. É informado "o que fazer" ao método de abertura da câmera através da implantação de listeners que são chamados em situações de sucesso ou erro.

Através da implementação dos listeners, você pode especificar o que acontece em seu App em situações de erro (método onErrorSelfie) ou sucesso (método onSuccessSelfie) na captura de imagens.

Método onSucessSelfie

Ao efetuar uma captura de imagem com sucesso, este método é invocado e retorna um objeto do tipo ResultCamera que é utilizado posteriormente na chamada das APIs REST:

O objeto ResultCamera retorna 2 atributos: base64 e encrypted:

• O atributo base64 pode ser utilizado se quiser exibir uma prévia da imagem em seu app;

Método onErrorSelfie

Ao ocorrer algum erro na captura de imagem, este método é invocado e retorna um objeto do tipo UnicoError:

Preparar e abrir câmera

O método openCameraSelfie é utilizado para abrir a camera. Este método recebe como parâmetro a implementação da classe UnicoSelfie e o JSON com as credenciais, gerado na etapa acima.

O exemplo a seguir ilustra os passos de configuração dos listeners e abertura da câmera:

Realize um requisição POST na API REST do by Client