Pular para o conteúdo principal
Este recurso é exclusivo de Chargefy for Platforms. Use uma chave secreta de plataforma com escopo platform_admin no servidor da sua aplicação.
Envie o CPF ou CNPJ na URL para receber todos os dados cadastrais disponíveis para aquele documento. O tipo é identificado automaticamente. A consulta funciona antes de cadastrar uma organização filha e usa somente a chave da plataforma, sem precisar do header Organization. Uma plataforma pode consultar o CNPJ de uma loja durante o cadastro e preencher razão social, endereço e contatos. Para uma pessoa, o CPF permite preencher nome, nascimento e os contatos disponíveis na base.
string
obrigatório
CPF com 11 dígitos ou CNPJ com 14 dígitos e dígitos verificadores válidos. Prefira enviar sem pontuação. Se enviar pontuação, codifique o valor como segmento de URL, incluindo a barra do CNPJ como %2F.
Os dados vinculados a um CPF podem conter imprecisões ou estar desatualizados, inclusive endereço, telefone e e-mail. Confirme as informações com o titular antes de utilizá-las. A consulta não comprova identidade ou titularidade dos contatos.

Consultar CPF

O objeto person reúne identificação, contato, endereço, poder aquisitivo e registro eleitoral. Os valores abaixo são ilustrativos.

Consultar CNPJ

O objeto company reúne cadastro, situação, contatos, atividades econômicas, porte, regimes tributários e quadro societário. Todos os contatos e sócios retornados pela fonte são incluídos.

Campos da resposta

Cada campo do contrato está sempre presente. Escalares e objetos sem dados retornam null; listas sem registros retornam []. Valores monetários são inteiros na menor unidade da moeda (centavos em brl) e usam a moeda brl.
string
Sempre document.
object | null
Dados empresariais para CNPJ. Retorna null para CPF.
object | null
Endereço cadastral disponível.
null | string
Município.
object | null
País, com código e nome quando disponíveis.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Nome do logradouro.
null | string
Complemento do endereço.
null | string
Código IBGE do município.
null | string
Bairro.
null | string
Número, preservado como texto.
null | string
CEP, preservado como texto.
null | string
Sigla da unidade federativa.
null | string
Tipo do logradouro, quando disponível separadamente.
null | number
Capital social na menor unidade da moeda (centavos em brl). Por exemplo, 1000050 representa R$ 10.000,50.
array
Todos os e-mails retornados pela fonte.
null | string
Endereço de e-mail.
null | string
Domínio do e-mail.
null | string
Classificação do contato informada pela fonte, como CORPORATE, PERSONAL ou ACCOUNTING.
null | boolean
Indica se o estabelecimento é a matriz.
null | string
Ente federativo responsável, quando aplicável.
Razão social.
Natureza jurídica, com código e descrição.
Código da classificação, preservado como texto.
Nome ou descrição.
object | null
Atividade econômica principal, com código CNAE e descrição.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
array
Quadro de sócios e administradores.
object | null
Representante legal do sócio, quando disponível.
object | null
Identificação do sócio ou representante, quando disponível.
null | string
Faixa etária informada pela fonte.
object | null
País, com código e nome quando disponíveis.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Documento do sócio ou representante como informado pela fonte. CPF pode vir parcialmente oculto.
null | string
Nome ou descrição.
null | string
Tipo de pessoa, como NATURAL, LEGAL, FOREIGN ou UNKNOWN.
object | null
Qualificação societária, com código e descrição.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
object | null
Identificação do sócio ou representante, quando disponível.
null | string
Faixa etária informada pela fonte.
object | null
País, com código e nome quando disponíveis.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Documento do sócio ou representante como informado pela fonte. CPF pode vir parcialmente oculto.
null | string
Nome ou descrição.
null | string
Tipo de pessoa, como NATURAL, LEGAL, FOREIGN ou UNKNOWN.
object | null
Qualificação societária, com código e descrição.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Data de início do vínculo ou enquadramento.
object | null
Enquadramento no MEI.
null | boolean
Indica opção ou enquadramento no regime.
null | string
Data de início do vínculo ou enquadramento.
null | string
Data de abertura no formato YYYY-MM-DD.
array
Todos os telefones retornados pela fonte.
null | string
DDD.
null | string
Código telefônico do país, como 55.
null | string
Número, preservado como texto.
null | string
Tipo informado pela fonte.
array
Atividades econômicas secundárias, com códigos CNAE e descrições.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
object | null
Opção pelo Simples Nacional.
null | boolean
Indica opção ou enquadramento no regime.
null | string
Data de início do vínculo ou enquadramento.
object | null
Porte empresarial.
null | string
Sigla do porte.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
object | null
Situação especial, quando aplicável.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Data da situação especial.
object | null
Situação cadastral, com código e descrição.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Data da situação cadastral.
object | null
Motivo da situação cadastral, quando disponível.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
array
Inscrições SUFRAMA retornadas pela fonte. Lista vazia quando não há dados disponíveis.
null | string
Data de aprovação do projeto.
null | boolean
Indica aprovação do projeto.
array
Incentivos fiscais retornados para a inscrição.
null | string
Base legal do incentivo.
null | string
Benefício fiscal.
null | string
Finalidade do incentivo.
null | string
Tributo incentivado.
null | string
Número, preservado como texto.
null | string
Data de início do vínculo ou enquadramento.
object | null
Situação cadastral, com código e descrição.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Nome fantasia.
string
Moeda dos valores monetários, sempre brl.
string
CPF ou CNPJ consultado, sem pontuação.
string
Tipo do documento, cpf ou cnpj.
boolean
true com chave de produção e false com chave de teste. Ambos consultam os dados disponíveis para o documento informado.
object | null
Dados pessoais para CPF. Retorna null para CNPJ.
object | null
Endereço cadastral disponível.
null | string
Município.
object | null
País, com código e nome quando disponíveis.
null | string
Código da classificação, preservado como texto.
null | string
Nome ou descrição.
null | string
Nome do logradouro.
null | string
Complemento do endereço.
null | string
Código IBGE do município.
null | string
Bairro.
null | string
Número, preservado como texto.
null | string
CEP, preservado como texto.
null | string
Sigla da unidade federativa.
null | string
Tipo do logradouro, quando disponível separadamente.
null | string
Data de nascimento no formato YYYY-MM-DD.
null | string
E-mail cadastral disponível.
string
Primeira palavra do nome.
string
Nome completo. Pode ser retornado sem acentos.
string
Demais palavras do nome.
object | null
Telefone cadastral disponível.
null | string
DDD.
null | string
Código telefônico do país, como 55.
null | string
Número, preservado como texto.
null | string
Tipo informado pela fonte.
object | null
Classificação de poder aquisitivo presente na base consultada.
null | string
Descrição da categoria de poder aquisitivo.
null | string
Código da categoria na classificação.
null | number
Renda registrada na base, na menor unidade da moeda (centavos em brl). Por exemplo, 250075 representa R$ 2.500,75. Retorna null quando não existe um valor numérico utilizável.
null | string
Descrição da faixa de renda registrada.
object | null
Dados de registro eleitoral presentes na base consultada.
null | string
Número do título de eleitor, preservado como texto.
null | string
Seção eleitoral, preservada como texto.
null | string
Zona eleitoral, preservada como texto.
null | string
Data de atualização informada pela fonte, em ISO 8601. Retorna null quando essa data não está disponível, como na consulta de CPF.

Disponibilidade dos dados

A consulta está disponível sem cota própria ou por chave. A capacidade e a atualização das fontes ainda determinam quando uma consulta pode ser atendida. Chaves de teste e produção consultam os dados reais disponíveis para o documento. A consulta de CNPJ informa a data de atualização em updated_at. O CPF de um sócio pode vir parcialmente oculto na fonte e é devolvido nesse formato.

Erros

Repita uma consulta que retornou 503 após um intervalo. Um 404 significa que a consulta foi concluída sem encontrar o documento.