# Documentação

- [Visão geral](/docs): O que a CNPJ API oferece, quais fontes integra e como a documentação está organizada.
- [Começar agora](/docs/getting-started): Configure a URL base, proteja sua chave e faça a primeira consulta por CNPJ.
- [Autenticação e segurança](/docs/authentication): API keys, ambientes, rotação, armazenamento seguro e comportamento do playground.
- [Erros e códigos HTTP](/docs/errors): Como tratar validação, ausência de dados, autenticação, limites e dependências indisponíveis.
- [Paginação, filtros e busca](/docs/pagination-and-filters): Limites, offset, filtros existentes e recursos que a API ainda não oferece.
- [Atualização e defasagem dos dados](/docs/data-freshness): Snapshots, versões publicadas, saúde das fontes e como distinguir indisponibilidade de ausência.
- [Boas práticas de integração](/docs/integration-practices): Cache, limites, CORS, versionamento, disponibilidade e práticas seguras para consumidores.
- Casos de uso
  - [Casos de uso](/docs/use-cases): Fluxos confirmados pelos endpoints atuais e as limitações que cada integração precisa considerar.
  - [Perfil e enriquecimento cadastral](/docs/use-cases/company-profile): Consulte situação, CNAE, Simples/MEI, matriz, filiais e quadro societário a partir de um CNPJ.
  - [Compliance e onboarding B2B](/docs/use-cases/compliance): Combine cadastro, situação, vínculos e ocorrências fiscais sem transformar a API em um motor de decisão.
  - [PGFN e dados tributários da RFB](/docs/use-cases/fiscal-data): Consulte dívida ativa, parcelamentos, transações e créditos ativos agregados respeitando a granularidade de cada fonte.
  - [Obras CNO e imóveis CAFIR](/docs/use-cases/works-and-properties): Consulte obras e imóveis rurais sem inferir correlações que as chaves atuais não suportam.
- Reference
  - Saúde: Disponibilidade da API e atualização das fontes.
    - [Verificar se o processo está ativo](/docs/reference/sa%C3%BAde/get_liveness)
    - [Verificar PostgreSQL e Redis](/docs/reference/sa%C3%BAde/get_readiness)
    - [Consultar atualização das fontes](/docs/reference/sa%C3%BAde/get_source_health)
  - C A F I R: Cadastro de imóveis rurais por NIRF e localização.
    - [Listar imóveis rurais](/docs/reference/cafir/list_cafir_properties)
    - [Consultar imóvel rural por NIRF](/docs/reference/cafir/get_cafir_property)
  - C N O: Cadastro Nacional de Obras e seus vínculos.
    - [Consultar obra por CNO](/docs/reference/cno/get_cno_work)
    - [Listar áreas da obra](/docs/reference/cno/list_cno_areas)
    - [Listar CNAEs da obra](/docs/reference/cno/list_cno_cnaes)
    - [Listar vínculos da obra](/docs/reference/cno/list_cno_links)
    - [Listar obras vinculadas ao CNPJ](/docs/reference/cno/list_cnpj_cno_works)
  - C N P J: Cadastro empresarial, estabelecimentos e sócios.
    - [Consultar perfil cadastral por CNPJ](/docs/reference/cnpj/get_cnpj_profile)
    - [Listar matriz e filiais](/docs/reference/cnpj/list_cnpj_establishments)
    - [Listar quadro societário](/docs/reference/cnpj/list_cnpj_partners)
  - P G F N: Dívida ativa publicada pela PGFN.
    - [Listar inscrições em dívida ativa](/docs/reference/pgfn/list_cnpj_pgfn_debts)
  - R F B: Parcelamentos, transações e créditos ativos da RFB.
    - [Listar parcelamentos tributários](/docs/reference/rfb/list_cnpj_rfb_installments)
    - [Listar transações tributárias](/docs/reference/rfb/list_cnpj_rfb_transactions)
    - [Listar créditos ativos agregados](/docs/reference/rfb/list_rfb_active_credits)
- [Perguntas frequentes](/docs/faq): Respostas curtas sobre cobertura, atualização, autenticação, limites e uso dos dados.
- [Suporte](/docs/support): Informações necessárias para diagnosticar uma integração sem compartilhar credenciais ou dados desnecessários.
- [Changelog](/docs/changelog): Alterações relevantes no contrato público e na documentação.
- Legal
  - [Termos de uso — minuta](/docs/legal/terms): Estrutura preliminar pendente de identificação da operadora e revisão jurídica antes da publicação comercial.
  - [Privacidade — minuta](/docs/legal/privacy): Estrutura preliminar de privacidade pendente de inventário, identificação do controlador e revisão jurídica.