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:
| Propriedade | Descrição |
|---|---|
| valid | Indica a autenticidade das informações verificadas na prova de vida. |
| cause | Código identificador do tipo da transação. |
| codId | Indica por qual motivo o processo finalizou sem sucesso. |
| protocol | Protocolo da transação de prova de vida. |
| scanResultBlob | É um blob criptografado para uso do SDK no tratamento do retorno. |
Tabela codeId
| codeId | Descrição |
|---|---|
| 1.0 | Prova de Vida Aprovada |
| 300.1 | Prova de Vida Reprovada (face não identificada; necessário retentativa) |
| 300.2 | Prova 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:
| Atributo | Descrição |
|---|---|
| code | Representação do erro em valor numérico. |
| message | Texto 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:
| Code | Message |
|---|---|
| 0 | App Key inválido. |
| 1 | Não foi concedida permissão de acesso à câmera do aparelho. |
| 2 | Sem conexão à Internet. |
| 3 | Prova de vida não foi completada. |
| 4 | Liveness 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:
| Propriedade | Descrição |
|---|---|
| valid | Indica a autenticidade das informações verificadas na prova de vida. |
| codID | Código identificador do tipo da transação. |
| cause | Indica por qual motivo o processo finalizou sem sucesso. |
| uidProtocol | Protocolo da transação de prova de vida. |
| codID | Descrição |
|---|---|
| 1.1 | Cadastro com sucesso. |
| 1.2 | Certificação positiva. (Conhecido = True) |
| 200.1 | Cadastro com alerta. |
| 200.2 | Certificação negativa. (Conhecido = True) |
| 200.3 | Certificação positiva. (Conhecido = False) |
| 200.4 | Certificação negativa. (Conhecido = False) |
| 200.5 | Validação na Base da Serpro |
| 300.1 | Prova de vida inválida. |
| 300.2 | Usuá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:
| Erro | Descrição |
|---|---|
| invalidAppKey | App Key inválido. |
| certifaceOff | Certiface offline. |
| noCameraPermission | Não foi concedida permissão de acesso à câmera do aparelho. |
| noInternetConnection | Dispositivo sem conexão à Internet. |
| phoneCallInProgress | Chamada telefônica em andamento. Não é possível iniciar o desafio durante uma chamada telefônica. |
| validationError | Erro na requisição de validação dos desafios. |
| challengeInterrupted | App foi minimizado durante o uso do FaceCaptcha, isso faz com que o desafio seja encerrado. |
| requestError | Erro na comunicação com o servidor. |
| errorCameraSetup | Erro ao configurar câmera |
| errorCapturePicture | Erro 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:
| Erro | Descrição |
|---|---|
| invalidAppKey | App Key inválido. |
| certifaceOff | Certiface offline. |
| cameraSetupFailed | Erro ao configurar a câmera. |
| noCameraPermission | Não foi concedida permissão de acesso à câmera do aparelho. |
| errorCapturePicture | Erro ao capturar foto. |
| noInternetConnection | Dispositivo sem conexão à Internet. |
| validationError | Erro na requisição de validação dos desafios. |
| faceCaptchaNotExecuted | FaceCaptcha não foi realizada. |
Updated about 1 month ago
