Guia de tratamento de retornos

Apresenta as informações necessárias sobre os diferentes tipos de retornos do plugin Flutter

Os parâmetros onSuccess e onError são responsáveis por receber os retornos do Widget para o devido tratamento.

Liveness 3D

1. Sucesso

O parâmetro onSuccess é uma função que recebe um objeto do tipo LivenessSuccessResult , que possui as seguintes propriedades:

PropriedadeDescrição
validIndica a autenticidade das informações verificadas na prova de vida.
causeCódigo identificador do tipo da transação.
codIdIndica por qual motivo o processo finalizou sem sucesso.
protocolProtocolo da transação de prova de vida.
scanResultBlobÉ um blob criptografado para uso do SDK no tratamento do retorno.

Tabela codeId

codeIdDescrição
1.0Prova de Vida Aprovada
300.1Prova de Vida Reprovada (face não identificada; necessário retentativa)
300.2Prova de Vida Reprovada (usuário bloqueado; retentativa não disponível)

2. Erro

O parâmetro onError é uma função que recebe um objeto indicando o erro ocorrido.

As propriedades encontradas no objeto estão listadas na tabela abaixo:

AtributoDescrição
codeRepresentação do erro em valor numérico.
messageTexto que contém uma mensagem explicativa sobre o erro.

Os casos de erro encontrados no objeto recebido por este método estão listado na tabela abaixo:

CodeMessage
0App Key inválido.
1Não foi concedida permissão de acesso à câmera do aparelho.
2Sem conexão à Internet.
3Prova de vida não foi completada.
4Liveness não foi inicializado corretamente.

4. Exemplo de uso

Após efetuar a importação da biblioteca, deve ser aplicada a App Key gerada dentro do parâmetro da função desejada, no exemplo abaixo chamamos a função quando clicamos no botão "Liveness 3D".

import 'package:flutter/material.dart';
import 'package:oiti_liveness3d/oiti_liveness3d.dart';
import 'package:oiti_liveness3d/common/enumerations.dart';

void main() => runApp(const MaterialApp(home: ExampleWidget()));

class ExampleWidget extends StatelessWidget {
  const ExampleWidget({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Liveness 3D'),
      ),
      body: Center(
        child: ElevatedButton(
          child: const Text('Open liveness'),
          onPressed: () => Navigator.push(
            context,
            MaterialPageRoute(
              builder: (context) => OitiLiveness3d.createLiveness3DWidget(
                appKey: 'APP-KEY',
                environment: Environment.hml,
                onSuccess: (result) => print(result.toString()),
                onError: (error) => print(error.toString()),
              ),
            ),
          ),
        ),
      ),
    );
  }
}


Liveness 2D

1. Sucesso

O parâmetro onSuccess é uma função que recebe um objeto do tipo LivenessSuccessResult que possui as seguintes propriedades:

O objeto recebido por este método possui as seguintes propriedades:

PropriedadeDescrição
validIndica a autenticidade das informações verificadas na prova de vida.
codIDCódigo identificador do tipo da transação.
causeIndica por qual motivo o processo finalizou sem sucesso.
uidProtocolProtocolo da transação de prova de vida.
codIDDescrição
1.1Cadastro com sucesso.
1.2Certificação positiva. (Conhecido = True)
200.1Cadastro com alerta.
200.2Certificação negativa. (Conhecido = True)
200.3Certificação positiva. (Conhecido = False)
200.4Certificação negativa. (Conhecido = False)
200.5Validação na Base da Serpro
300.1Prova de vida inválida.
300.2Usuário foi bloqueado.

Erro

O parâmetro onError é uma função que recebe um objeto indicando o erro ocorrido.

As propriedades encontradas no objeto estão listadas na tabela abaixo:

ErroDescrição
invalidAppKeyApp Key inválido.
certifaceOffCertiface offline.
noCameraPermissionNão foi concedida permissão de acesso à câmera do aparelho.
noInternetConnectionDispositivo sem conexão à Internet.
phoneCallInProgressChamada telefônica em andamento. Não é possível iniciar o desafio durante uma chamada telefônica.
validationErrorErro na requisição de validação dos desafios.
challengeInterruptedApp foi minimizado durante o uso do FaceCaptcha, isso faz com que o desafio seja encerrado.
requestErrorErro na comunicação com o servidor.
errorCameraSetupErro ao configurar câmera
errorCapturePictureErro ao capturar foto.

Doc Core

1. Sucesso

O parâmetro onSuccess é uma função que recebe um objeto do tipo DocSuccessResult que possui as seguintes propriedades:

2. Erro

Os casos de erro encontrados no objeto recebido por este método estão listados na tabela abaixo:

ErroDescrição
invalidAppKeyApp Key inválido.
certifaceOffCertiface offline.
cameraSetupFailedErro ao configurar a câmera.
noCameraPermissionNão foi concedida permissão de acesso à câmera do aparelho.
errorCapturePictureErro ao capturar foto.
noInternetConnectionDispositivo sem conexão à Internet.
validationErrorErro na requisição de validação dos desafios.
faceCaptchaNotExecutedFaceCaptcha não foi realizada.