Consulta cadastral
Consultar dados cadastrais
Consulte dados cadastrais de CPF e CNPJ com a chave de API da plataforma.
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.
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 objetoperson reúne identificação, contato, endereço, poder aquisitivo e
registro eleitoral. Os valores abaixo são ilustrativos.
Consultar CNPJ
O objetocompany 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 retornamnull; listas sem registros retornam []. Valores monetários são
inteiros na menor unidade da moeda (centavos em brl) e usam a moeda brl.
Capital social na menor unidade da moeda (centavos em
brl). Por exemplo, 1000050 representa R$ 10.000,50.Documento do sócio ou representante como informado pela fonte. CPF pode vir
parcialmente oculto.
Documento do sócio ou representante como informado pela fonte. CPF pode vir
parcialmente oculto.
true com chave de produção e false com chave de teste. Ambos consultam os
dados disponíveis para o documento informado.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.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 emupdated_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.
