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 (Prova de Vida)

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 que está sendo executado. Esta tecnologia existe para prevenir fraudes biométricas com pessoas se passando por outras em processos como em criações de contas bancárias, em compras, em transferências de valores, etc. A captura de Liveness, com Anti-Spoofing, evita que um indivíduo tire uma foto de uma foto ou uma foto de um vídeo, bem como outras medidas mais avançadas de mitigação de tentativas de fraudes, garantindo 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

⚠️
A utilização de aplicativos de terceiros nos dispositivos dos usuários, tais como bloqueadores de anúncios, serviços de VPN e proxies privados, pode ocasionar restrições ou impedimentos no funcionamento dos SDKs de Liveness. Recomendamos orientar os usuários a permitirem o domínio '*.clearsale.com.br' nessas ferramentas e/ou serviços para evitar possíveis interferências no desempenho do sistema.

Dados

Entradas

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.
cpf
identifierId

Retornos

Para retornos Real:
- sessionId: Id da sessão.
- Imagem capturada no formato base64.
Do contrário, o retorno será um erro (tanto para casos de identificação de spoof quanto para erros).

Credenciais

Nós enviamos por e-mail as seguintes credenciais que devem ser implementadas para utilizar os nossos SDK:

Para todos os SDK:

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

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.
- Formato: [email protected]
CS_LIVENESS_VERSION: versão do SDK que se deseja instalar.
- Formato: X.X.X ou X.X.X-hml

iOS

git:: URL do nosso repositório git privado já com o PAT (token de acesso ao repositório).

Browser

Base64PAT: PAT (token de acesso ao repositório) já convertido para o formato base64 necessário para integrar ao nosso NPM privado.

Requisitos de Atualização

Frequentemente 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.