API atual/Referência completa/Utilidades da vitrine

Validar CPF e CNPJ

Confere os dígitos verificadores de um CPF ou CNPJ e devolve o número formatado.

CPF é o documento de pessoa física no Brasil (11 dígitos) e CNPJ o de pessoa jurídica (14 caracteres). Os dois terminam em dígitos verificadores calculados a partir dos demais. Estas rotas conferem só essa conta, sem consultar a Receita Federal: um número pode estar "válido" e não existir de verdade. Servem para avisar o cliente de um erro de digitação antes de enviar o formulário.

Exigem o módulo cpf-cnpj-validation ligado na loja.

Validar CPF

POST/api/v1/storefront/validate/cpfPública

Valida um CPF

Corpo da requisição

cpfstringobrigatório

CPF do cliente com ou sem pontuação.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/validate/cpf" \
  -H "Content-Type: application/json" \
  -d '{
  "cpf": "123.456.789-09"
}'

Resposta

200CPF válido

json

{ "valid": true, "formatted": "123.456.789-09" }

200CPF inválido (ainda é 200)

json

{ "valid": false, "formatted": "111.111.111-11" }

Campos da resposta

validboolean

true quando os dígitos verificadores conferem. Sequências de um dígito só (111.111.111-11) são sempre inválidas.

formattedstring

O CPF no formato 000.000.000-00 sempre que o texto tem exatamente 11 dígitos, mesmo que seja inválido. Com outra quantidade de dígitos, volta o texto enviado, sem mudança.

Erros

Status	Quando	Corpo
400	Corpo que não é JSON.	`{"error":"invalid request body"}`
403	Módulo `cpf-cnpj-validation` desligado.	`{"error":"module_disabled","module":"cpf-cnpj-validation"}`

Validar CNPJ

POST/api/v1/storefront/validate/cnpjPública

Valida um CNPJ

Corpo da requisição

cnpjstringobrigatório

CNPJ da empresa com ou sem pontuação.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/validate/cnpj" \
  -H "Content-Type: application/json" \
  -d '{
  "cnpj": "11.222.333/0001-81"
}'

Resposta

200CNPJ válido

json

{ "valid": true, "formatted": "11.222.333/0001-81" }

Campos da resposta

validboolean

true quando os dígitos verificadores conferem. Aceita o CNPJ alfanumérico (letras e números); letras minúsculas são tratadas como maiúsculas. Sequências de um caractere só são inválidas.

formattedstring

O CNPJ no formato 00.000.000/0000-00 quando tem 14 caracteres válidos; caso contrário volta o texto enviado.

Erros

Status	Quando	Corpo
400	Corpo que não é JSON.	`{"error":"invalid request body"}`
403	Módulo `cpf-cnpj-validation` desligado.	`{"error":"module_disabled","module":"cpf-cnpj-validation"}`

Veja também

Validar CPF e CNPJ

Confere os dígitos verificadores de um CPF ou CNPJ e devolve o número formatado.

Exigem o módulo cpf-cnpj-validation ligado na loja.

Validar CPF

POST/api/v1/storefront/validate/cpfPública

Valida um CPF

Corpo da requisição

cpfstringobrigatório

CPF do cliente com ou sem pontuação.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/validate/cpf" \
  -H "Content-Type: application/json" \
  -d '{
  "cpf": "123.456.789-09"
}'

Resposta

200CPF válido

json

{ "valid": true, "formatted": "123.456.789-09" }

200CPF inválido (ainda é 200)

json

{ "valid": false, "formatted": "111.111.111-11" }

Campos da resposta

validboolean

true quando os dígitos verificadores conferem. Sequências de um dígito só (111.111.111-11) são sempre inválidas.

formattedstring

O CPF no formato 000.000.000-00 sempre que o texto tem exatamente 11 dígitos, mesmo que seja inválido. Com outra quantidade de dígitos, volta o texto enviado, sem mudança.

Erros

Status	Quando	Corpo
400	Corpo que não é JSON.	`{"error":"invalid request body"}`
403	Módulo `cpf-cnpj-validation` desligado.	`{"error":"module_disabled","module":"cpf-cnpj-validation"}`

Validar CNPJ

POST/api/v1/storefront/validate/cnpjPública

Valida um CNPJ

Corpo da requisição

cnpjstringobrigatório

CNPJ da empresa com ou sem pontuação.

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/storefront/validate/cnpj" \
  -H "Content-Type: application/json" \
  -d '{
  "cnpj": "11.222.333/0001-81"
}'

Resposta

200CNPJ válido

json

{ "valid": true, "formatted": "11.222.333/0001-81" }

Campos da resposta

validboolean

true quando os dígitos verificadores conferem. Aceita o CNPJ alfanumérico (letras e números); letras minúsculas são tratadas como maiúsculas. Sequências de um caractere só são inválidas.

formattedstring

O CNPJ no formato 00.000.000/0000-00 quando tem 14 caracteres válidos; caso contrário volta o texto enviado.

Erros

Status	Quando	Corpo
400	Corpo que não é JSON.	`{"error":"invalid request body"}`
403	Módulo `cpf-cnpj-validation` desligado.	`{"error":"module_disabled","module":"cpf-cnpj-validation"}`