API atual/Referência completa/Autenticação

Verificações de formato

Valida o formato de um e-mail, CPF ou CNPJ antes do cadastro, sem revelar se o dado já existe.

Formulários de cadastro costumam validar o campo enquanto a pessoa digita. Estas três rotas públicas fazem isso: conferem o formato (e, para CPF e CNPJ, os dígitos verificadores) sem exigir login nem captcha.

Como todas pertencem a /api/v1/auth/, dividem o limite de 10 requisições por minuto por IP. Faça debounce e não chame a cada tecla.

Verificar e-mail

GET/api/v1/auth/check-emailPública

Verificar o formato de um e-mail

Parâmetros de consulta

emailstringobrigatório

E-mail a verificar. Vale como formato válido se tiver @ e pelo menos 5 caracteres.

bash

curl "$BASE_URL/api/v1/auth/check-email?email=ana@example.com"

200Formato verificado

json

{ "available": true, "email": "ana@example.com", "valid": true }

Verificar CPF

GET/api/v1/auth/check-cpfPública

Validar um CPF

Parâmetros de consulta

cpfstringobrigatório

CPF, com ou sem pontuação. Só os dígitos são considerados.

bash

curl "$BASE_URL/api/v1/auth/check-cpf?cpf=123.456.789-09"

200CPF verificado

json

{ "available": true, "cpf": "12345678909", "valid": true }

Verificar CNPJ

GET/api/v1/auth/check-cnpjPública

Validar um CNPJ

Parâmetros de consulta

cnpjstringobrigatório

CNPJ, com ou sem pontuação (14 caracteres). Aceita o CNPJ alfanumérico.

bash

curl "$BASE_URL/api/v1/auth/check-cnpj?cnpj=11222333000181"

200CNPJ verificado

json

{ "available": true, "cnpj": "11222333000181", "valid": true }

Campos da resposta

validboolean

true quando o formato (e os dígitos verificadores, em CPF e CNPJ) está correto. Um documento incompleto vale false.

availableboolean

Sempre true. Mantido por estabilidade do contrato; não indica disponibilidade real.

emailstring

Eco do e-mail enviado. Só em check-email.

cpfstring

Eco do CPF, só dígitos. Só em check-cpf.

cnpjstring

Eco do CNPJ normalizado (sem pontuação, maiúsculas). Só em check-cnpj.

Erros

Status	Quando	Corpo
400	Parâmetro ausente	`{"error":"email_required","detail":"email query parameter is required"}` (também `cpf_required`, `cnpj_required`)
429	Limite de 10 por minuto por IP excedido	`{"error":"rate limit exceeded",...}`

Veja também

Verificações de formato

Valida o formato de um e-mail, CPF ou CNPJ antes do cadastro, sem revelar se o dado já existe.

Como todas pertencem a /api/v1/auth/, dividem o limite de 10 requisições por minuto por IP. Faça debounce e não chame a cada tecla.

Verificar e-mail

GET/api/v1/auth/check-emailPública

Verificar o formato de um e-mail

Parâmetros de consulta

emailstringobrigatório

E-mail a verificar. Vale como formato válido se tiver @ e pelo menos 5 caracteres.

bash

curl "$BASE_URL/api/v1/auth/check-email?email=ana@example.com"

200Formato verificado

json

{ "available": true, "email": "ana@example.com", "valid": true }

Verificar CPF

GET/api/v1/auth/check-cpfPública

Validar um CPF

Parâmetros de consulta

cpfstringobrigatório

CPF, com ou sem pontuação. Só os dígitos são considerados.

bash

curl "$BASE_URL/api/v1/auth/check-cpf?cpf=123.456.789-09"

200CPF verificado

json

{ "available": true, "cpf": "12345678909", "valid": true }

Verificar CNPJ

GET/api/v1/auth/check-cnpjPública

Validar um CNPJ

Parâmetros de consulta

cnpjstringobrigatório

CNPJ, com ou sem pontuação (14 caracteres). Aceita o CNPJ alfanumérico.

bash

curl "$BASE_URL/api/v1/auth/check-cnpj?cnpj=11222333000181"

200CNPJ verificado

json

{ "available": true, "cnpj": "11222333000181", "valid": true }

Campos da resposta

validboolean

true quando o formato (e os dígitos verificadores, em CPF e CNPJ) está correto. Um documento incompleto vale false.

availableboolean

Sempre true. Mantido por estabilidade do contrato; não indica disponibilidade real.

emailstring

Eco do e-mail enviado. Só em check-email.

cpfstring

Eco do CPF, só dígitos. Só em check-cpf.

cnpjstring

Eco do CNPJ normalizado (sem pontuação, maiúsculas). Só em check-cnpj.

Erros

Status	Quando	Corpo
400	Parâmetro ausente	`{"error":"email_required","detail":"email query parameter is required"}` (também `cpf_required`, `cnpj_required`)
429	Limite de 10 por minuto por IP excedido	`{"error":"rate limit exceeded",...}`