SDK de Captura de Documentos

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

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, iOS, JavaScript e plugins Flutter e React Native, é 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.

Upload de documentos digitais

Recentemente foi lançada a feature de upload de documentos digitais para a plataforma Web. É possível enviar um arquivo PDF de até 5MB contendo uma CNH ou RG digitais.

Documentos aceitos

Através dos nossos motores de tipificação de documentos, nosso produto é capaz de identificar os seguintes documentos:

• Carteira Nacional de Habilitação (CNH). Períodos de emissão:
  • 2006 – 2016: impresso;
  • 2017 – 2022: impresso e digital*;
  • 06/2022 - Atual: impresso e digital*;
• Carteira de Identidade ou Registro Geral (RG). Períodos de emissão:
  • 1983 - 2022**: impresso;
• Documento Nacional de Identidade (DNI / RG). Período de emissão:
  • 2018 - 2023**: impresso;
• Carteira de Identidade Nacional (CIN). Período de emissão:
  • 06/2022 - Atual: impresso e digital*;
• Registro Nacional de Estrangeiro / Registro Nacional Migratório (RNE/RNM).**
  • Digital - Atual;
  • Cartão policarbonato (plástico) desde 2017;

*Apenas via upload no SDK Web.

**Atualmente disponível apenas no SDK Web.

🚧

Caso não seja identificado algum dos modelos de 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.

Além disso, são feitas validações de foco do documento na imagem. 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;
• Capturas são feitas somente com a câmera traseira do dispositivo;
• Os arquivos enviados (upload) devem conter certificado digital emitido por órgão credenciado;
• 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.

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.

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.