POSTMAN

1 min

Comece a testar agora mesmo utilizando o Postman.

Copie sua Chave de API disponível na página de detalhes de sua Conta.

Abra a collection através do botão abaixo e cole-a em:
Headers > Authorization

GUIA RÁPIDO

5 min

Tutorial online de como enviar uma requisição para a API.

Aprenda passo a passo como consultar a Receita Federal, SINTEGRA e Simples Nacional.

Entenda a diferença de Cache e Tempo Real.

CNPJá!

GUIA COMPLETO

25 min

A documentação completa e oficial de nossos serviços.

Inclui detalhes extras como descrição das propriedades e tipagem de objetos.

Versionada em nosso reposítório do GitHub.

MAPA DE SERVIÇOS

A seguir montamos um diagrama para visualização rápida das consultas disponíveis em nossa API, e as informações retornadas.

Ao enviar uma requisição,  será debitado uma quantidade de créditos  ) de sua conta.

Para entender mais sobre este sistema, refira-se a página de Planos.

A URL base de todas as requisições é:

não trabalhamos com protocolo HTTP

O tempo de resposta de cada serviço está disponível na página de Status.

 

CONSULTA POR CNPJ

Todas as consultas ao CNPJ utilizam a Receita Federal como ponto de partida.

Opcionalmente, você pode adicionar as informações do SINTEGRA e Simples Nacional.

Tempo Real são dados extraídos no mesmo momento da consulta na fonte oficial.

Enquanto Cache é um dado previamente adquirido e armazenado por nós .

O retorno do Cache reduz o custo, porém está sujeito a disponibilidade.

Refira-se ao Guia Rápido para mais detalhes da configuração.

GET

/companies/{cnpj}?

Receita Federal

Tempo Real: 1 ₪

Cache: 0,2 ₪

• Razão Social

• Nome Fantasia

• Tipo e Porte

• Capital Social

• E-mail e Telefones

• Situação Cadastral

• Situação Cadastral Especial

• Endereço Completo

• Código IBGE do Município

• Natureza Jurídica

• Ente Federativo Responsável

• Atividades Econômicas

• Quadro de Sócios

• Links de Comprovantes PDF

&sintegra_max_age={dias}

SINTEGRA

Tempo Real: +15 ₪

Cache: +0 ₪

• Incrições Estaduais

  • Número

  • Estado

  • Status

&simples_max_age={dias}

Simples Nacional

Tempo Real: +30 ₪

Cache: +0 ₪

• Optante Pelo Simples

• Data de Inclusão no Simples

• Data de Exclusão do Simples

• Optante Pelo SIMEI

DOWNLOAD DE ARQUIVOS

A consulta por CNPJ irá disponibilizar links para download de documentos em PDF ou imagens.

Estes links são compostos por um token que está diretamente vinculado a sua conta.

Cada tipo de arquivo possui uma cobrança em créditos diferente, refira-se ao lado para detalhes.

Atente-se ao exibir ou compartilhar estes links em sua aplicação pois eles não requerem autenticação.

/files/{token}

GET

Tipos de Arquivo

• Comprovante de Inscrição: 5 ₪

• Quadro de Sócios e Adm: 5 ₪

• Mapa Aéreo 2D: 15 ₪

• Mapa Satétile: 15 ₪

• Street View: 25 ₪

INFORMAÇÕES DA CONTA

Utilize estas rotas para consulta seu saldo restante, status da assinatura e histórico de requisições.

Ao visualizar o histórico disponiblizamos o status de cada requisição, tempo de resposta e custo em créditos.

GET

/me

Dados Pessoais

• Nome e E-mail

• Créditos Restantes

• Status da Conta

• Plano Contratado

GET

/me/requests

Histórico

• Data e Hora

• ID da Requisição

• Status HTTP

• Tempo de Resposta

• Créditos Utilizados

  • Instagram
  • Facebook
  • Twitter
  • LinkedIn

© CNPJá! 2020 • Todos os Direitos Reservados