BR Doc

Brazilian documents validator for Go.

Everything in this file, except this section and the License one, is in Portuguese.

BR Doc é um pacote para validação, tanto do formato quanto dos dígitos, de documentos brasileiros.

Aceito PRs de todas as formas. Está permitido escrever em português, também. :)

Instalação:

go get github.com/paemuri/brdoc/v4

Funções públicas:

• func IsCPF(doc string) bool
• func IsCNPJ(doc string) bool: CNPJ numérico ou alfanumérico
• func IsPhone(phone string) (valid bool, ufs []UF): telefone fixo ou celular, retornando as UFs do DDD
• func IsPhoneFrom(phone string, ufs ...UF) bool: telefone de uma das UFs dadas
• func IsCEP(doc string) (valid bool, uf UF): CEP, retornando sua UF
• func IsCEPFrom(doc string, ufs ...UF) bool: CEP de uma das UFs dadas
• func IsPlate(doc string) bool: placa veicular, nacional ou Mercosul
• func IsNationalPlate(doc string) bool: placa no padrão nacional antigo (AAA-1111)
• func IsMercosulPlate(doc string) bool: placa no padrão Mercosul (AAA1A11)
• func IsVoterID(doc string) bool: título de eleitor
• func IsCNH(doc string) bool: Carteira Nacional de Habilitação
• func IsPIS(doc string) bool: PIS/PASEP, também funciona para NIS e NIT
• func IsRENAVAM(doc string) bool: Registro Nacional de Veículos Automotores
• func IsCNS(doc string) bool: Cartão Nacional de Saúde
• func IsIE(doc string, uf UF) bool: Inscrição Estadual
• func IsCNJ(doc string) bool: número de processo judicial
• func IsCivilCertificate(doc string) bool: matrícula de certidão de registro civil (nascimento, casamento ou óbito)
• func IsNFE(doc string) bool: chave de acesso de NF-e, NFC-e, CT-e, MDF-e e outros documentos fiscais eletrônicos
• func IsBankSlip(doc string) bool: boleto, tanto bancário quanto de arrecadação (contas de consumo e tributos), pelo código de barras ou pela linha digitável
• func IsCNO(doc string) bool: Cadastro Nacional de Obras, também funciona para a matrícula CEI de obras
• func IsPixKey(key string) bool: chave Pix (CPF, CNPJ, telefone, e-mail ou chave aleatória), no formato do DICT, sem máscara
• func IsPixBRCode(doc string) bool: BR Code do Pix (conteúdo do QR Code, ou "Pix copia e cola"), estático, dinâmico ou composto

Tipos públicos:

• type UF string: representa cada unidade federativa

Exemplo:

import "github.com/paemuri/brdoc/v4"

func main() {
	brdoc.IsCPF("123.456.789-09")                  // true
	valid, ufs := brdoc.IsPhone("(11) 99999-9999") // true, [SP]
	brdoc.IsIE("110.042.490.114", brdoc.SP)        // true
}

This project code is in the public domain. See the LICENSE file.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be in the public domain, without any additional terms or conditions.