PIX Key

Valide chave Pix com reconhecimento automático em JavaScript e TypeScript.

Use o validador de chave Pix para reconhecer automaticamente CPF, CNPJ, e-mail, telefone ou chave aleatória (EVP), com implementação completa em JavaScript, TypeScript e Node.js na validation-br. Chave Pix é o apelido que identifica uma conta bancária pro Pix, e esse validador identifica sozinho qual desses tipos foi informado. É o validador mais indicado para campos genéricos de "chave Pix" em formulários de pagamento, já que evita ter que perguntar ao usuário qual tipo de chave ele está informando.

Gerar chave de exemplo

+5543971489323

Tipos de chave suportados

Cada tipo de chave é validado internamente por um validador próprio, com suas próprias regras e particularidades — por exemplo, a chave aleatória (EVP) é sempre um UUID, mas só é aceita a versão 4.

Tipo	Validador	Documentação
CPF	isCPF	/v2/cpf
CNPJ	isCNPJ	/v2/cnpj
E-mail	isEmail	/v2/email
Telefone	isPhone	/v2/phone
Aleatória (EVP)	isUUID (só v4)	/v2/uuid

Como a validação funciona

O PixKey testa o valor contra os validadores disponíveis (isCPF, isCNPJ, isUUID pro EVP, isEmail e isPhone) — o primeiro que casar define o `type`, exposto com o valor do enum `PixKeys`.

Exemplos (API)

// Validar e obter o tipo
const pk = new PixKey('user@example.com')
console.log('pk.value', pk.value)           // -> 'user@example.com'
console.log('pk.toString()', pk.toString()) // -> 'user@example.com'
console.log('pk.mask()', pk.mask())         // -> 'user@example.com'
console.log('PixKey.type', pk.type) // 'email'

// Gerar chaves fake por tipo
console.log('PixKey.fake("cpf")', PixKey.fake({ type: 'cpf' }).toString())
console.log('PixKey.fake("cnpj")', PixKey.fake({ type: 'cnpj' }).toString())
console.log('PixKey.fake("evp")', PixKey.fake({ type: 'evp' }).toString())

// Sem tipo, gera um tipo aleatório
console.log('PixKey.fake()', PixKey.fake().toString())