Bem-vindo à documentação do Liveness da ClearSale

Este manual é para desenvolvedores que desejam fazer uso da ferramenta de prova de vida (também conhecida como Liveness).

Através deste recurso, é possível comprovar através de biometria facial se o usuário por trás é uma pessoa real e está realizando o procedimento ao vivo, caso não seja, será retornado um erro.

A ClearSale respeita as políticas de privacidade para a formação de uma base de dados por meio de coleta de fotos, que serão armazenadas em ambiente seguro e controlado.

Nesse processo, podem ser coletadas informações públicas do dispositivo, tais como IP, sistema operacional, entre outras, através do uso de ferramentas terceiras com a finalidade de coletar insumos sobre a utilização da ferramenta para futuras melhorias.

A ClearSale tem interesse legítimo em fornecer serviços de prevenção à fraude a partir de formação de perfis comportamentais, os quais são lícitos e representam uma finalidade legítima, considerada a partir de situações concretas, tal como exigido pela LGPD.

Mais informações de como estamos preocupados e atuando para cumprimento da LGPD, veja o link.

O Produto

Liveness

Liveness é o processo automatizado de prova de vida, cujo foco é definir se a pessoa por trás de uma selfie está viva e ciente do processo de biometria ou facematch que está sendo executado. Esta tecnologia existe para prevenir fraudes biométricas com pessoas se passando por outras em processos como: criação de contas bancárias, compras, transferência de valores, etc. A captura de LIVENESS (prova de vida), com Anti-Spoofing, evita que um indivíduo tire uma foto de uma foto ou uma foto de um vídeo, por exemplo, e garante que existe um ser humano realmente vivo em frente à câmera.

Tecnologia de Liveness 3D

A tecnologia de liveness 3D que utilizamos é considerada atualmente a melhor solução de liveness do mundo, com um FAR (taxa de aprovação com erro) de 1 a cada 125 milhões. A solução apresenta ótimo desempenho mesmo em baixa iluminação, sem vieses raciais ou de gênero observáveis, e o 3D não pode ser capturado à distância ou clandestinamente. A solução não requer que o usuário que está atrás da câmera realize desafios, mas apenas ações simples, combatendo um cenário de spoof ou falsificação. Estas ações ocorrem em duas etapas: um enquadramento inicial e, na sequência, um enquadramento aproximado.

Regras de Segurança

  • Detecção de uso de câmera em outro aplicativo
  • Detecção de aplicativo de terceiros modificando vídeo
  • Usos suspeitos de webcam
  • Bloqueio de uso de câmera em modo paisagem em dispositivos móveis e tablets
  • Não é permitido uso em segundo plano
  • Tempo limite para interações (detecta inatividade)
  • Não funciona em iframes e webviews
  • Se o PAT for salvo em um repositório git, mesmo que seja um repositório privado, ele corre risco de ser considerado exposto e ser automaticamente desativado por motivos de segurança

Dados

Entradas

  • clientID
  • clientSecret
  • cpf (opcional)
  • identifierId (opcional)

Retornos

  • Id da sessão
  • Imagem capturada (uma) no formato base64
  • Um resultado definindo se o usuário é Real ou se ocorreu um Erro

Credenciais

Nós enviamos por email as seguintes credenciais que devem ser usadas para utilizar os nossos SDK.

Android

ARTIFACTS_FEED_NAME - nome do repositório do gradle privado que disponibilizamos para o download do SDK.
ARTIFACTS_FEED_URL - URL do repositório do gradle privado que disponibilizamos para o download do SDK.
USERNAME - nome do usuário do repositório gradle privado que disponibilizamos para o download do SDK.
CS_LIVENESS_VERSION - é a versão do SDK que se deseja instalar.

iOS

URL Repositório git: - é a url do nosso repositório git privado já com o PAT.
Browser
Base64PAT - é o nosso PAT já convertido para o formato base64 necessário para integrar no nosso NPM privado.

Para todos os SDks:

clientId - identifica o cliente junto à ClearSale. Ele é utilizado no momento da inicialização dos SDK. para a utilização dos SDKs.

clientSecret - chave de autenticação da ClearSale. Ele é utilizado no momento da inicialização dos SDK. para a utilização dos SDKs.

PAT - token de autenticação para acessar e baixar os repositórios dos SDK's da ClearSale. Ele deve ser usado em locais diferentes a depender da tecnologia a ser usada, abaixo listamos como usá-lo em cada uma delas.

Exemplos de como usar o PAT

Requisitos de Atualização

De tempos em tempos serão solicitadas atualizações dos SDKs via e-mail. Elas são de extrema importância para o funcionamento correto dos SDKs e também para segurança de uso. Para garantia de qualidade é obrigatório a atualização sempre que disponível.