SDK Flutter Liveness

v2.0.0

Introdução

O objetivo deste manual é fornecer todas as informações necessárias para instalação e uso da ferramenta nos aplicativos desenvolvidos para plataforma Flutter.

Este SDK realiza a captura de faces para processamento de Liveness pela ClearSale. Todas as informações coletadas são dados relacionados apenas ao dispositivo, sem relação ao aplicativo integrado.

As informações de captura de imagem dependem da permissão concedida pelo usuário no momento de captura. Neste caso é necessário que o aplicativo solicite o acesso à câmera ao usuário para dar prosseguimento à coleta de prova de vida.

O SDK respeita a política de privacidade da Google para a captura dos dados do dispositivo e o nível de permissão atribuído pelo usuário (usuário do dispositivo).

Instalação

flutter pub add liveness_flutter_sdk
liveness_flutter_sdk:
git:
    url: https://github.com/ClearSale/LivenessPluginFlutter.git,
    ref: master

🚧

Caso sua aplicação utilize a ferramenta Sentry, a versão compatível do sentry_flutter é a 8.0.0.

Android

Requisitos

  • Versão do sistema operacional Android: 5.0 (API v21)+
  • compileSdk versão: 33
  • targetSdk versão: 33
  • com.google.android.material:material: 1.5.0+
  • kotlin_version 1.6.10+

Instalação

Adicione um arquivo clearsale.gradle.env na raiz do seu projeto flutter.
Esse arquivo deve conter as seguintes propriedades:

CS_LIVENESS_TEC_ARTIFACTS_FEED_URL=ARTIFACTS_FEED_URL // valor fornecido pela clear sale
CS_LIVENESS_TEC_ARTIFACTS_FEED_NAME=ARTIFACTS_FEED_NAME // valor fornecido pela clear sale
CS_LIVENESS_TEC_USER=USERNAME // valor fornecido pela clear sale
CS_LIVENESS_TEC_PASS=ACCESSTOKEN // valor fornecido pela clear sale
CS_LIVENESS_VERSION=LAST_VERSION // valor da última release

iOS

Requisitos

  • Versão do sistema operacional iOS: 12.0 ou superior
  • Versão do projeto Swift 4+: funciona com Xcode anterior ao 13.

Instalação

No arquivo Podfile de seu projeto adicione o seguinte código:

platform :ios, '12.0'

use_frameworks!

target 'NOME_DO_SEU_PROJETO' do
  pod 'CSLivenessSDK', :git => 'https://CS-Packages:[email protected]/CS-Package/ID-Lab-PackagesSDK/_git/CSLivenessSDK', :tag => 'VERSION_HERE'
end

Instruções de uso

Importe o plugin no seu projeto e use o método openCSLiveness que irá chamar a SDK nativa do dispositivo.

O resultado da função open é um future que pode retornar os seguintes valores:

class CSLivenessResult {
  final bool real;
  final String sessionId;
  final String image;
  final String? responseMessage;
}

🚧

Caso o future seja rejeitado, ela retorna o erro que causou a rejeição (CSLivenessResult no Android, CSLivenessError no iOS e UserCancel).

Exemplo de uso

// Platform messages are asynchronous, so we initialize in an async method.
Future<void> callCSLivenessSDK(
    String clientId,
    String clientSecretId,
    String identifierId,
    String cpf,
    bool vocalGuidance,
    Color primaryColor,
    Color secondaryColor,
    Color titleColor,
    Color paragraphColor) async {
  // Platform messages may fail, so we use a try/catch PlatformException.
  // We also handle the message potentially returning null.
  String result;
  try {
    var sdkResponse =
    await _livenessFlutterSdkPlugin.openCSLiveness(
        clientId,
        clientSecretId,
        identifierId,
        cpf,
        vocalGuidance,
        primaryColor,
        secondaryColor,
        titleColor,
        paragraphColor);

    result = jsonEncode(sdkResponse);
  } on PlatformException catch (e) {
    result = "Error: $e";
  } catch (e) {
    result = "Error: $e";
  }

  // If the widget was removed from the tree while the asynchronous platform
  // message was in flight, we want to discard the reply rather than calling
  // setState to update our non-existent appearance.
  if (!mounted) return;

  setState(() {
    _result = result;
  });
}

Executando o aplicativo de exemplo

  1. Conecte um dispositivo físico (Android ou iOS - o nosso SDK não roda em emuladores, apenas em dispositivos fisícos) à sua máquina de desenvolvimento.
  2. Clone esse repositório e rode flutter pub get.
  3. Coloque suas credenciais no arquivo clearsale.gradle.env na raiz do projeto de exemplo e adicione também as credenciais no arquivo example/ios/Podfile.
  4. Inicie o app
  5. Ao pressionar o botão Open CSLiveness o SDK DocumentosCopy iniciará. Após completar o fluxo o aplicativo retorna o documentType e sessionId.

Detalhes de privacidade

Uso de dados

Todas as informações coletadas pelo SDK da ClearSale são com exclusiva finalidade de prevenção à fraude e proteção ao próprio usuário, aderente à política de segurança e privacidade das plataformas Google e Apple e à LGPD. Por isso, estas informações devem constar na política de privacidade do aplicativo.

Tipo de dados coletados

O SDK da ClearSale coleta as seguintes informações do dispositivo :

  • Características físicas do dispositivo/ hardware (Como tela, modelo, nome do dispositivo)
  • Características de software (Como versão, idioma, build, controle parental)
  • Informações da câmera
  • Licença de Uso

Ao realizar o download e utilizar nosso SDK você estará concordando com a seguinte licença:

Todos os direitos são reservados, sendo concedida a permissão para usar o software da maneira como está, não sendo permitido qualquer modificação ou cópia para qualquer fim. O Software é licenciado com suas atuais configurações “tal como está” e sem garantia de qualquer espécie, nem expressa e nem implícita, incluindo mas não se limitando, garantias de comercialização, adequação para fins particulares e não violação de direitos patenteados. Em nenhuma hipótese os titulares dos Direitos Autorais podem ser responsabilizados por danos, perdas, causas de ação, quer seja por contrato ou ato ilícito, ou outra ação tortuosa advinda do uso do Software ou outras ações relacionadas com este Software sem prévia autorização escrita do detentor dos direitos autorais.

Copyright © 2022 ClearSale