> ## Documentation Index
> Fetch the complete documentation index at: https://docs.judit.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Glossário Jurídico e Técnico — Judit API

> Termos jurídicos e técnicos usados pela Judit API: CNJ, OAB, CNPJ, BNMP, Hot Storage, datalake, webhook, response_type e muito mais.

Glossário organizado em três camadas: **conceitos jurídicos** (sistema brasileiro), **propriedades de payload** (campos dos requests/responses) e **arquitetura interna** (datalake, hot storage, crawler).

> 🤖 Use este glossário como referência rápida. Para a estrutura completa de cada objeto (Lawsuit, Entity, Warrant, Penal Execution), consulte os [Schemas](/schemas/lawsuit-object).

## Conceitos jurídicos brasileiros

<AccordionGroup>
  <Accordion title="Identificadores oficiais">
    | Termo    | Significado                                                                                                |
    | :------- | :--------------------------------------------------------------------------------------------------------- |
    | **CNJ**  | Código Nacional de Justiça — número único do processo no padrão `NNNNNNN-DD.AAAA.J.TR.OOOO` (20 dígitos).  |
    | **CPF**  | Cadastro de Pessoas Físicas (Receita Federal). 11 dígitos.                                                 |
    | **CNPJ** | Cadastro Nacional da Pessoa Jurídica. 14 dígitos. Aceita o novo formato **alfanumérico** (IN RFB 2229/24). |
    | **OAB**  | Ordem dos Advogados do Brasil. Identificador do advogado, formato `<número><UF>` (ex.: `123456SP`).        |
    | **RJI**  | Registro Judiciário Individual atribuído pelo BNMP 2.0 a cada pessoa procurada.                            |
  </Accordion>

  <Accordion title="Estrutura do processo">
    | Termo                   | Significado                                                                                                        |
    | :---------------------- | :----------------------------------------------------------------------------------------------------------------- |
    | **Capa do processo**    | Conjunto de dados-cabeçalho: número, classe, assunto, valor da causa, partes, data de distribuição, comarca, juiz. |
    | **Andamento (step)**    | Cada movimentação/lançamento registrado nos autos. Exibido em ordem cronológica.                                   |
    | **Parte (party)**       | Pessoa física, jurídica ou autoridade envolvida (Autor, Réu, Interessado, Advogado).                               |
    | **Polo**                | Lado do processo: `Active` (Autor), `Passive` (Réu), `Interested` (Terceiro).                                      |
    | **Comarca (county)**    | Divisão territorial do sistema judiciário — jurisdição de um juiz de 1ª instância.                                 |
    | **Vara (court)**        | Unidade jurisdicional dentro de uma comarca (Cível, Criminal, Trabalhista, etc.).                                  |
    | **Instância**           | Grau do processo: 1 (originário) ou 2 (recurso/apelação).                                                          |
    | **Classe processual**   | Tipo do procedimento (ex.: Procedimento Comum Cível, Mandado de Segurança).                                        |
    | **Assunto**             | Tema/matéria do processo segundo a tabela CNJ (ex.: Acidente de Trânsito).                                         |
    | **Distribuição**        | Data em que o processo foi oficialmente atribuído a uma vara.                                                      |
    | **Trânsito em julgado** | Decisão final, sem possibilidade de recurso.                                                                       |
  </Accordion>

  <Accordion title="Justiças e tribunais">
    | Termo                    | Significado                                                             |
    | :----------------------- | :---------------------------------------------------------------------- |
    | **Justiça Estadual**     | TJ de cada UF — competência geral civil/criminal estadual.              |
    | **Justiça Federal**      | TRFs (1 a 6) — União, autarquias, conflitos federais.                   |
    | **Justiça do Trabalho**  | TST + TRTs (1 a 24) — relações trabalhistas.                            |
    | **Justiça Eleitoral**    | TSE + TREs — eleições e crimes eleitorais.                              |
    | **Justiça Militar**      | STM + Justiça Militar Estadual — crimes militares.                      |
    | **Tribunais Superiores** | STF, STJ, TST, TSE, STM.                                                |
    | **BNMP**                 | Banco Nacional de Mandados de Prisão — base do CNJ com mandados ativos. |

    Lista completa: [Cobertura de Tribunais](/resource/courtCoverage).
  </Accordion>

  <Accordion title="Sigilo e justiça criminal">
    | Termo                   | Significado                                                                                                                         |
    | :---------------------- | :---------------------------------------------------------------------------------------------------------------------------------- |
    | **Segredo de justiça**  | Processo restrito a partes vinculadas. Exige credencial do advogado (ver [Cofre de Credenciais](/essentials/cofre-de-credenciais)). |
    | **`secrecy_level` 0–5** | Escala de sigilo. `0` = público; `5` = sigilo absoluto.                                                                             |
    | **Mandado de prisão**   | Ordem judicial de prisão (preventiva, temporária, definitiva, recaptura). Coletado do BNMP.                                         |
    | **Execução penal**      | Processo de cumprimento de pena, com fases como progressão e livramento.                                                            |
  </Accordion>
</AccordionGroup>

## Propriedades do payload (request/response)

<AccordionGroup>
  <Accordion title="Identificação da requisição">
    | Campo         | O que é                                                             |
    | :------------ | :------------------------------------------------------------------ |
    | `request_id`  | UUID gerado quando você cria uma requisição (`POST /requests`).     |
    | `response_id` | UUID de cada resposta gerada para uma requisição (pode ter várias). |
    | `tracking_id` | UUID de um monitoramento (`POST /tracking`).                        |
    | `callback_id` | UUID único de cada entrega de webhook (use para idempotência).      |
    | `origin_id`   | UUID que liga várias requisições filhas a uma requisição-pai.       |
  </Accordion>

  <Accordion title="Cache e atualidade">
    | Campo                   | O que é                                                                                                     |
    | :---------------------- | :---------------------------------------------------------------------------------------------------------- |
    | `cache_ttl_in_days`     | Quantos dias o resultado em cache continua válido antes de forçar coleta nova.                              |
    | `cached_response`       | `true` = resposta veio do datalake; `false` = coleta atual no tribunal. Veja [Webhook](/webhook/callbacks). |
    | `is_fallback_source`    | Indica que o dado veio de fonte secundária (ex.: tribunal estava fora do ar).                               |
    | `dictionary_updated_at` | Data da última atualização dos dicionários (assuntos, classes).                                             |
  </Accordion>

  <Accordion title="Busca (search)">
    | Campo                       | O que é                                                                                               |
    | :-------------------------- | :---------------------------------------------------------------------------------------------------- |
    | `search_type`               | `cpf`, `cnpj`, `oab`, `name`, `lawsuit_cnj`, `lawsuit_id`, `rji` ou `custom`.                         |
    | `search_key`                | Valor concreto a buscar (CPF, CNPJ, número CNJ, etc.).                                                |
    | `response_type`             | Formato esperado de resposta: `lawsuit`, `entity`, `warrant`, `execution`.                            |
    | `on_demand`                 | Se `true`, força leitura em tempo real (custo maior). Vale para `/entities` e consultas históricas.   |
    | `with_attachments`          | Se `true`, baixa anexos (apenas para `search_type: lawsuit_cnj` ou warrant).                          |
    | `reveal_partners_documents` | (CNPJ) Retorna CPFs/CNPJs dos sócios sem mascaramento.                                                |
    | `customer_key`              | Chave do [Cofre de Credenciais](/essentials/cofre-de-credenciais) para acessar processos sob segredo. |
  </Accordion>

  <Accordion title="Filtros (search_params.filter)">
    | Campo                                     | O que é                                                                               |
    | :---------------------------------------- | :------------------------------------------------------------------------------------ |
    | `side`                                    | Lado da parte: `Active`, `Passive`, `Interested`, `Unknown`.                          |
    | `amount_gte` / `amount_lte`               | Valor da causa mínimo/máximo.                                                         |
    | `distribution_date_gte` / `_lte`          | Janela de distribuição.                                                               |
    | `last_step_date_gte` / `_lte`             | Janela da última movimentação.                                                        |
    | `tribunals.keys` + `not_equal`            | Inclui (false) ou exclui (true) tribunais — ver [Cobertura](/resource/courtCoverage). |
    | `subject_codes.keys` + `not_equal`        | Códigos oficiais CNJ de assunto.                                                      |
    | `classification_codes.keys` + `not_equal` | Códigos oficiais CNJ de classe.                                                       |
    | `party_names`                             | Filtro por nome de parte.                                                             |
    | `party_documents`                         | Filtro por CPF/CNPJ de parte.                                                         |
  </Accordion>

  <Accordion title="Paginação e listagem">
    | Campo             | O que é                                          |
    | :---------------- | :----------------------------------------------- |
    | `page`            | Página atual (1-based).                          |
    | `page_size`       | Itens por página (máx. 1000).                    |
    | `page_count`      | Total de itens nesta página.                     |
    | `all_count`       | Total absoluto de itens encontrados pelo filtro. |
    | `all_pages_count` | Total de páginas considerando `page_size`.       |
    | `page_data`       | Array com os itens da página corrente.           |
  </Accordion>

  <Accordion title="Tracking (monitoramento)">
    | Campo                             | O que é                                                      |
    | :-------------------------------- | :----------------------------------------------------------- |
    | `recurrence`                      | Intervalo (em dias) entre execuções do monitoramento.        |
    | `notification_emails`             | Emails que recebem notificação a cada atualização.           |
    | `notification_filters.step_terms` | Termos que filtram quais movimentações disparam notificação. |
    | `tracked_items_count`             | Total de itens (processos) que o tracking está acompanhando. |
    | `hour_range`                      | Hora do dia em que o tracking executa.                       |
  </Accordion>

  <Accordion title="Entity (dados cadastrais)">
    | Campo                    | O que é                           |
    | :----------------------- | :-------------------------------- |
    | `entity_id`              | UUID interno da entidade.         |
    | `entity_type`            | `person` (PF) ou `company` (PJ).  |
    | `main_document`          | CPF (PF) ou CNPJ (PJ).            |
    | `aka_names`              | Outros nomes/apelidos associados. |
    | `addresses`              | Lista de endereços.               |
    | `contacts`               | Telefones e emails.               |
    | `parents`                | (PF) Filiação (mãe/pai).          |
    | `partners`               | (PJ) Sócios e administradores.    |
    | `branch_activities`      | (PJ) Atividades CNAE.             |
    | `legal_nature`           | (PJ) Natureza jurídica.           |
    | `revenue_service_active` | Status na Receita Federal.        |
  </Accordion>

  <Accordion title="Warrant (mandado de prisão)">
    | Campo                                  | O que é                                                  |
    | :------------------------------------- | :------------------------------------------------------- |
    | `warrant_type`                         | `warrant_of_arrest` (prisão) ou `recapture` (recaptura). |
    | `arrest_type`                          | `preventive`, `temporary`, `definitive`.                 |
    | `law_type.number` / `description`      | Lei/artigos infringidos.                                 |
    | `issue_date` / `expiration_date`       | Datas de emissão e validade.                             |
    | `duration_years` / `_months` / `_days` | Pena calculada.                                          |
    | `regime`                               | `Aberto`, `Semiaberto`, `Fechado`.                       |
    | `judgementSummary`                     | Texto da sentença/despacho.                              |
  </Accordion>

  <Accordion title="Erros">
    | Campo               | O que é                                                               |
    | :------------------ | :-------------------------------------------------------------------- |
    | `error.name`        | Nome do erro (ex.: `HttpBadRequestError`, `HttpNotFoundError`).       |
    | `error.message`     | Grupo do erro (ex.: `BAD_REQUEST`).                                   |
    | `error.data`        | Detalhes/mensagens de validação.                                      |
    | `LAWSUIT_NOT_FOUND` | `application_error` retornado quando a busca não encontra o processo. |
  </Accordion>
</AccordionGroup>

## Arquitetura interna da Judit

<AccordionGroup>
  <Accordion title="Componentes">
    | Termo           | O que é                                                                                     |
    | :-------------- | :------------------------------------------------------------------------------------------ |
    | **Datalake**    | Repositório central de processos coletados pela Judit (≈ centenas de milhões de processos). |
    | **Hot Storage** | Camada de cache de alta performance — fonte das consultas síncronas.                        |
    | **Crawler**     | Robô que coleta dados nos tribunais. Cada coleta gera um `crawl_id`.                        |
    | **On-Demand**   | Modo de busca em tempo real, ignorando o datalake.                                          |
  </Accordion>

  <Accordion title="Serviços (microserviços)">
    | Serviço      | URL                            | Função                                        |
    | :----------- | :----------------------------- | :-------------------------------------------- |
    | **Requests** | `requests.production.judit.io` | Criação e leitura de requisições assíncronas. |
    | **Tracking** | `tracking.production.judit.io` | Monitoramento contínuo.                       |
    | **Lawsuits** | `lawsuits.production.judit.io` | Datalake síncrono, dados cadastrais, anexos.  |
    | **Crawler**  | `crawler.production.judit.io`  | Cofre de Credenciais.                         |
    | **User**     | (interno)                      | Autenticação e gestão de callbacks.           |
  </Accordion>

  <Accordion title="Eventos do webhook">
    | Evento              | Quando dispara                                 |
    | :------------------ | :--------------------------------------------- |
    | `response_created`  | Cada nova resposta gerada (cache ou tribunal). |
    | `request_completed` | Fim do fluxo de uma requisição.                |
    | `tracking_response` | Cada nova movimentação detectada por tracking. |

    Ver detalhes em [Webhooks](/webhook/callbacks).
  </Accordion>

  <Accordion title="Tags e metadados">
    | Termo                                    | O que é                                                |
    | :--------------------------------------- | :----------------------------------------------------- |
    | `crawl_id`                               | UUID da execução do robô que coletou aquele dado.      |
    | `dashboard_id`                           | (Opcional) Vinculação com painéis específicos.         |
    | `criminal`                               | `true` quando o processo é da esfera criminal.         |
    | `is_fallback_source`                     | Dado coletado de fonte secundária.                     |
    | `revenue_update_date`                    | Última atualização da Receita Federal para a entidade. |
    | `datalake_id` / `datalake_segment`       | Identificadores internos do datalake.                  |
    | `possible_homonym` / `potential_homonym` | Indica suspeita de homônimo no resultado.              |
  </Accordion>
</AccordionGroup>

## Próximos passos

* **[Cobertura de Tribunais](/resource/courtCoverage)** — siglas para usar em filtros.
* **[Schema Lawsuit](/schemas/lawsuit-object)** — estrutura completa do objeto principal.
* **[Enums](/schemas/lawsuit-enums)** — valores literais aceitos por cada propriedade.
* **[FAQ](/resource/faq)** — perguntas frequentes.
