Documentação Validador-BR

Valide documentos brasileiros com facilidade

Veja como usar a biblioteca para validar CPFs, CNPJs, CNHs, PIS e muito mais.

NPM VersionNPM Downloads

Começando

Sobre

@box4dev/validador-br

Uma biblioteca leve e robusta para validar documentos brasileiros.

A biblioteca tem como objetivo garantir que os documentos obedeçam aos cálculos matemáticos e de dígito verificador estipulados pelas instituições.

Instalação

Para instalar o pacote em seu projeto, execute um dos comandos abaixo:

NPM

Shell
1
npm install @box4dev/validador-br

Yarn

Shell
1
yarn add @box4dev/validador-br

PNPM

Shell
1
pnpm add @box4dev/validador-br

Importação

Named exports (recomendado)

Use as funções nomeadas para importar apenas o que você precisa.

JS
1
2
3
import { isValidCpf, isValidCnpj } from '@box4dev/validador-br';
console.log(isValidCpf('123.456.789-09')); // true ou false
console.log(isValidCnpj('GY.HU8.PG2/971E-10')); // true ou false

Objeto validate (centralizado)

Ou use o objeto `validate` que centraliza todos os validadores.

JS
1
2
3
import { validate } from '@box4dev/validador-br';
console.log(validate.cpf('123.456.789-09')); // true ou false
console.log(validate.cnpj('12.345.678/0001-95')); // true ou false

CommonJS (require)

JS
1
2
3
const { isValidCpf, isValidCnpj, validate } = require('@box4dev/validador-br');
console.log(isValidCpf('12345678909')); // true ou false
console.log(validate.cnpj('GYHU8PG2971E10')); // true ou false

Validadores

CPF

Valida o formato e os dígitos verificadores do CPF (módulo 11).

JS
1
2
3
import { isValidCpf } from '@box4dev/validador-br';
console.log(isValidCpf('741.535.041-30')); // true ou false
console.log(isValidCpf('43241612163')); // true ou false

CNPJ / CNPJ Alfanumérico

Valida CNPJs no padrão antigo (apenas números) e no novo padrão alfanumérico.

JS
1
2
3
4
5
import { isValidCnpj } from '@box4dev/validador-br';
console.log(isValidCnpj('GY.HU8.PG2/971E-10')); // true ou false
console.log(isValidCnpj('12.345.678/0001-95')); // true ou false
console.log(isValidCnpj('AYWO9JCVCHFB47')); // true ou false
console.log(isValidCnpj('47434563000151')); // true ou false

CNH

Valida a Carteira Nacional de Habilitação usando o algoritmo oficial.

JS
1
2
import { isValidCnh } from '@box4dev/validador-br';
console.log(isValidCnh('12345678901')); // true ou false

PIS / PASEP / NIT

Valida o Número de Identificação do Trabalhador (PIS/PASEP/NIT).

JS
1
2
3
import { isValidPis } from '@box4dev/validador-br';
console.log(isValidPis('589.21704.72.2')); // true ou false
console.log(isValidPis('07987894517')); // true ou false

CNS

Valida números do CNS provisórios (iniciados com 7, 8, 9) e definitivos (1, 2).

JS
1
2
3
import { isValidCns } from '@box4dev/validador-br';
console.log(isValidCns('252 9608 1932 0002')); // true ou false
console.log(isValidCns('146471200460007')); // true ou false

Título de Eleitor

Valida o título de eleitor verificando os dígitos e o código do estado.

JS
1
2
3
import { isValidTituloEleitor } from '@box4dev/validador-br';
console.log(isValidTituloEleitor('4113 4513 0930')); // true ou false
console.log(isValidTituloEleitor('428779582410')); // true ou false

Certidão

Valida a matrícula de 32 dígitos de certidões (Nascimento, Casamento e Óbito).

JS
1
2
3
import { isValidCertidao } from '@box4dev/validador-br';
console.log(isValidCertidao('106836 11 1926 1001 1 88626 162 6561443')); // true ou false
console.log(isValidCertidao('81007223197120011105781766173474')); // true ou false

Inscrição Estadual

Valida IEs específicas de cada estado (UF). Requer a sigla do estado.

JS
1
2
3
4
import { isValidIE } from '@box4dev/validador-br';
// valor da IE e UF
console.log(isValidIE('7122026812064', 'SP')); // true ou false
console.log(isValidIE('01.004.823/001-12', 'AC')); // true ou false

Cartão de Crédito

Valida cartões (Visa, Mastercard, Amex, etc) usando o Algoritmo de Luhn.

JS
1
2
3
import { isValidCartaoCredito } from '@box4dev/validador-br';
console.log(isValidCartaoCredito('4389 3536 3524 6297')); // true ou false
console.log(isValidCartaoCredito('4389351453183261')); // true ou false

Perguntas Frequentes