br-agefy
v1.2.0
Published
Um sistema criado para desenvolvedores Brasileiros verificarem a idade de seus usuários sem ter que gastar nada.
Readme
Olá! Obrigado por baixar o br-agefy. O br-agefy é uma bblioteca desenvolvida por Davi de Castro em 2026, pensando em facilitar a verificação de idade de usuários usando OCR.
Usando a biblioteca
Função: processarDocumento(caminho)
Para começar a usar a biblioteca, você usa a função processarDocumento() e o único parâmetro dela deve ser o caminho do documento. O que ela faz:
- Trata a imagem usando SHARP para melhorar a leitura do OCR
- Lê os dados da imagem, usando OCR (Tesseract.Js)
- Retorna a idade do usuário e se o documento é válido
OBSERVAÇÃO: Não use o br-agefy por 100% de confiança, ele é um OCR e pode ter falhas. Além disso, ele não usa uma API do Governo para verificar a validade do documento.
Para verificar um documento, a lib faz os seguintes requisitos:
- O CPF é válido matematicamente? Passa para o próximo requisito.
- A data de validade da CIN ainda não expirou? Passa para o próximo requisito.
- O documento possui características da CIN oficial? Passa.
Retorno da processarDocumento(caminho)
Retorno:
- sucess: Booleano
- dados: array (Só existe quando o documento é válido.)
- mensagem: string (Só existe quando ocorre um erro.)
Conteúdo da array "dados":
- idade
- cpf
- validade
Depois que isso tudo acontece, o documento é deletado, priorizando a LGPD. Aceito contribuições!
Obrigado por usar o br-agefy!
