Referências do TypeScript

Tipos

FaceAuthenticatorResponse

Campo	Tipo	Descrição
resultado	FaceAuthenticatorResult	Mostra quando a autenticação facial retorna uma captura bem-sucedida.
erro	FaceAuthenticatorError	Mostra quando a autenticação facial retorna algum erro.
cancelado	booleano	Mostra quando o usuário cancela a autenticação.
isLoading	booleano	Mostra quando a autenticação facial está carregando.

FaceAuthenticatorResult

Campo	Tipo	Descrição
signedResponse	string	A resposta assinada confirmando que a selfie capturada é genuína.

FaceAuthenticatorError

Campo	Tipo	Descrição
mensagem	string	Mensagem detalhada de erro.
erro	Erro	Enum que descreve o tipo de erro.

FaceAuthenticatorSettings

Campo	Tipo	Descrição	Android	iOS
cafStage	Estágio	Usado para redirecionar o SDK para o estágio desejado na API CAF.	✅	✅
filter	Filtro	Usado para alterar o filtro do SDK.	✅	✅
imageUrlExpirationTime	Tempo	Usado para personalizar o tempo de expiração da URL da imagem.	✅	✅
enableScreenshots	booleano	Usado para habilitar capturas de tela durante a varredura do SDK. Desativado por padrão por motivos de segurança.	✅	✅
loadingScreen	booleano	Usado para habilitar uma barra de progresso de carregamento padrão durante eventos de carregamento.	✅	✅
certificates	string[]	Usado para definir certificados fixados para a implementação de reverse proxy.	❌	✅
livenessBaseUrl	string	Usado para habilitar o uso de um proxy reverso para executar o liveness. Se usado, os certificados devem ser definidos com o método setCertificates.	❌	✅
authenticationBaseUrl	string	Usado para habilitar o uso de reverse proxy para executar as autenticações do SDK.	❌	✅

Enumerações

Estágio

Campo	Descrição	Android	iOS
BETA	Ambiente beta.	✅	✅
PROD	Ambiente de produção.	✅	✅

Filtro

Campo	Descrição	Android	iOS
LINE_DRAWING	Máscara alternativa para a verificação de vivacidade facial.	✅	✅
NATURAL	Máscara normal para a verificação de vivacidade facial.	✅	✅

Tempo

Campo	Descrição	Android	iOS
THREE_HOURS	O tempo de expiração da URL da imagem expira em três horas.	✅	✅
THIRTY_DAYS	O tempo de expiração da URL da imagem expira em trinta dias.	✅	✅
THIRTY_MIN	O tempo de expiração da URL da imagem expira em trinta minutos.	❌	✅

Erro

Campo	Descrição	Android	iOS
UnknownException	Indica um problema desconhecido.	✅	✅
CameraPermission	Indica que a permissão da câmera é necessária para a verificação de vivacidade.	✅	✅
NetworkException	Indica que ocorreu uma exceção relacionada à rede durante a verificação.	✅	✅
ServerException	Indica que ocorreu uma exceção no lado do servidor durante a verificação.	✅	✅
TokenException	Indica um problema com o token usado para verificação.	✅	✅
UnsupportedDevice	Indica que o dispositivo não é compatível com a verificação de vivacidade.	✅	✅
CertificateException	Indica que ocorreu uma exceção no pinning de certificados.	❌	✅