CLEARSALE

Início

Suggest Edits

SDK de Captura de Documentos

Este manual é para desenvolvedores que desejam fazer a implementação da ferramenta de Captura de documentos ClearSale via SDKs para sistemas em Android e iOS.

Através desta solução, o usuário consegue capturar a frente e verso de documentos de identidade de forma ágil e eficiente, com instruções simples e objetivas, além de diversas orientações visuais e um fluxo pensado em uma excelente usabilidade. Também é possível customizar a interface para se adequar às cores da sua marca.

O Produto

Captura de documentos

Através de SDKs disponíveis em Android e iOS, é possível capturar frente e verso de documentos utilizando a câmera do dispositivo do usuário. O fluxo padrão compreende:

  • Solicitação de permissão de acesso à câmera.
  • Instruções para uma boa captura.
  • Feedbacks em caso de capturas inválidas/descartes.
  • Captura e revisão da foto da face da frente do documento.
  • Captura e revisão da foto da face do verso do documento.
  • Envio das capturas da frente e verso do documento.

As imagens enviadas pelos usuários podem ser resgatadas através de consulta na API.

Documentos aceitos

Através dos nossos motores de tipificação de documentos, os SDKs são capazes de identificar os seguintes documentos:

  • CNH:
    • CNH [<03/2006].
    • CNH [03/2006 - 12/2016].
    • CNH [01/2017 - 06/2022].
    • CNH [>06/2022].
    • CNH Digital.
  • Carteira de Identidade ou Registro Geral (RG):
    • RG [<1983].
    • RG [1983 - 2022*].
    • RG [2018* - 2022].
    • RG [>2022].
    • RG Digital.

🚧

Caso não seja identificado algum dos modelos dos documentos descritos acima, a captura é classificada como "discard" automaticamente.

Qualidade das capturas

Através dos nossos motores de IQA (Image Quality Assessment), os SDKs são capazes de validar os seguintes parâmetros:

  • Nível de exposição à iluminação (gamma).
  • Nível de ruído.
  • Nível de borrosidade.

As validações de qualidade das capturas asseguram a assertividade das análises feitas posteriormente pela API de Validação por Documentos.

Regras de Segurança

  • Bloqueio de uso de câmera em modo paisagem em dispositivos móveis e tablets;
  • 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

Entrada:

ParâmetrosDescrição
clientIdId que identifica o cliente junto à ClearSale (valor fornecido pela ClearSale).
clientSecretToken que funciona como autenticação para identificação do cliente a utilizar o serviço (valor fornecido pela ClearSale).
identifierIdString de até 100 caracteres OBRIGATÓRIA que identifica todo o fluxo do usuário de forma única e é gerada pelo cliente. Serve para agilizar consultas e chamados de suporte (e pode ser utilizada como identificador interno entre produtos aqui da ClearSale).
cpfString de 11 caracteres (no formato CPF) OBRIGATÓRIA que identifica o usuário que irá realizar o fluxo, devendo seguir as regras de validade estipuladas pelo Governo.

Retorno

ParâmetroDescrição
sessionIdID único da sessão, requisito para a recuperação da imagem.
documentTypeResultado do tipo do documento.

Disclaimer

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. Para mais informações de como atuamos no cumprimento da LGPD, veja o link.

Credenciais

Além do clientId e clientSecret, nós enviamos as seguintes credenciais que devem ser usadas para implementar nossos SDKs:

Para todos os SDKs:

ParâmetroDescrição
PAT (Personal Access Token)Token de autenticação para acessar os repositórios privados dos SDK's da ClearSale. Ele deve ser usado em locais diferentes a depender da tecnologia a ser usada.

Exemplos de utilização do PAT:

  • PAT SDK iOS clique aqui.
  • PAT SDK Android clique aqui.

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 do Repositório git: URL do nosso repositório git privado já com o PAT (token de acesso ao repositório).

Requisitos de Atualização

Periodicamente serão divulgadas novas versões dos SDKs via e-mail. Manter seus SDKs atualizados na última versão garante maior segurança e usabilidade para os usuários de seus aplicativos. Confira as últimas release notes aqui.

Updated 14 days ago