Resposta dos SDKs

Visão geral

Esta página explica os motivos pelos quais um SDK é encerrado. Para isso, verifique a instância da SDKFailure classe de objeto presente no objeto de resultado.

InstanceOf	Descrição	Exemplo	SDKs presentes
null	O SDK foi fechado com sucesso. Seus objetos de retorno estão preenchidos corretamente.	Quando o usuário executa com sucesso as etapas internas	DocumentDetector, PassiveFaceLiveness, FaceAuthenticator
InvalidTokenReason	O token inserido não é válido para o produto correspondente	Parametrize "test123" como token no construtor do SDK	DocumentDetector, PassiveFaceLiveness, FaceAuthenticator
PermissionReason	Você não possui algumas permissões obrigatórias para executar o SDK	Inicie o DocumentDetector sem permissão de câmera concedida	DocumentDetector, PassiveFaceLiveness, FaceAuthenticator, AddressCheck
AvailabilityReason	O SDK ainda não está disponível para uso. A variável SDKFailure.getMessage() contém instruções para o usuário	O armazenamento interno do dispositivo está cheio ao instalar o aplicativo, e o modelo de detecção facial não pode ser instalado junto	PassiveFaceLiveness, FaceAuthenticator
NetworkReason	Falha na conexão com a internet	O usuário estava sem internet durante o facematch no FaceAuthenticator	DocumentDetector, PassiveFaceLiveness, FaceAuthenticator, AddressCheck
ServerReason	Quando uma requisição do SDK recebe um código de status de falha	Em teoria, isso não deveria acontecer. Se você vir algo assim, avise-nos!	DocumentDetector, PassiveFaceLiveness, FaceAuthenticator, AddressCheck
SecurityReason	Quando o SDK não pode ser iniciado por um motivo de segurança	Quando o Google Security Provider não está sendo atualizado	DocumentDetector, PassiveFaceLiveness, FaceAuthenticator
StorageReason	Não há espaço no armazenamento interno do dispositivo do usuário	Quando não há espaço no armazenamento interno durante a captura da foto do documento	DocumentDetector, PassiveFaceLiveness, FaceAuthenticator
LibraryReason	Quando uma biblioteca interna do SDK não pode ser iniciada	Esquecer de configurar theCompress levará a essa falha no DocumentDetector	DocumentDetector
InvalidFaceReason	Não há registro facial para o peopleId informado	Quando o usuário se autentica com um peopleId que não possui registro facial	FaceAuthenticator

Exemplo

O exemplo a seguir mostra como descobrir e lidar com o motivo do encerramento do SDK DocumentDetector usando Kotlin:

    override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
        super.onActivityResult(requestCode, resultCode, data)
        if (requestCode == REQUEST_CODE && resultCode == RESULT_OK) {
            val result = data?.getSerializableExtra(
                DocumentDetectorResult.PARAMETER_NAME
            ) as DocumentDetectorResult

            if (!result.wasSuccessful()) {
                result.sdkFailure?.let {
                    onSdkFailure(it)
                }
                return
            }

            println("DocumentDetectorResult: $result")
        } else {
            println("O usuário cancelou a operação")
        }
        super.onActivityResult(requestCode, resultCode, data)
    }

    private fun onSdkFailure(sdkFailure: SDKFailure?) {
        when (sdkFailure) {
            is InvalidTokenReason -> {
                println("SDKFailure: O token inserido como parâmetro não é válido, revise-o")
            }
            is PermissionReason -> {
                println("SDKFailure: O usuário não concedeu as permissões necessárias")
            }
            is AvailabilityReason -> {
                println("SDKFailure: As instruções são enviadas em: ${sdkFailure.message}")
            }
            is NetworkReason -> {
                println("SDKFailure: Houve um problema com a conexão com a internet")
            }
            is ServerReason -> {
                println("SDKFailure: Houve um problema em qualquer comunicação com os servidores da CAF, avise-nos!")
            }
            is SecurityReason -> {
                println("SDKFailure: Houve um problema de segurança no dispositivo do usuário")
            }
            is StorageReason -> {
                println("SDKFailure: Houve um problema com o armazenamento interno do dispositivo do usuário")
            }
            is LibraryReason -> {
                println("SDKFailure: Houve um problema com a biblioteca interna")
            }
            else -> {
                println("SDKFailure: Motivo desconhecido")
            }
        }
    }

Retornos de segurança

Estamos constantemente tomando ações para tornar o produto mais seguro, mitigando muitos ataques observados nos processos de captura e reduzindo ao máximo possível as tentativas de fraude de identidade. Os erros descritos aqui são retornados no mensagem campo do SecurityReason classe.

Erro 300

Representa o bloqueio de dispositivos com o modo desenvolvedor ativo.

O modo desenvolvedor permite aos usuários acessar configurações avançadas, como depurar aplicativos via USB. Por padrão, os SDKs bloqueiam dispositivos no modo desenvolvedor.

Para desativar essa validação, use o .setUseDeveloperMode(bool use) método no SDK Builder.

Erro 400

Representa o bloqueio de dispositivos com o Android Debug Bridge (ADB) ativado.

O ADB permite aos usuários instalar e depurar aplicativos e acessar um shell Unix. Por padrão, os SDKs bloqueiam dispositivos com ADB ativado.

Para desativar essa validação, use o .setUseAdb(bool use) método no SDK Builder.

Erro 500

Representa o bloqueio de dispositivos com o modo de depuração ativado.

O modo de depuração permite aos usuários depurar aplicativos via USB, permitindo que eles contornem os fluxos do SDK. Por padrão, os SDKs bloqueiam dispositivos no modo de depuração.

Para desativar essa validação, use o .setUseDebug(bool use) método no SDK Builder.

Erro 600

Representa o bloqueio de dispositivos com assinaturas de aplicativos fraudulentas.

A verificação de assinatura bloqueia ataques de engenharia reversa e todos os outros ataques maliciosos que podem ser feitos após esse processo, no qual a assinatura original do aplicativo é alterada. Por isso, os SDKs realizam esse bloqueio por padrão.

Se você quiser desativar essa validação, use o .checkAppSignature(use: Boolean) método no SDK Builder.