Skip to main content

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.

🤖 This document lists the literal values accepted and returned by the properties of the Judit API across its various Schemas. Remember that in the lawsuit object, the header properties (such as area, status, situation, secrecy_level) are nested inside the root response_data object, while side and person_type are inside the objects in the parties array.

​
Lawsuit Areas (area)

List of legal areas (Branches of Law) that a lawsuit or execution may have:
  • DIREITO À EDUCAÇÃO
  • DIREITO DA CRIANÇA E DO ADOLESCENTE
  • DIREITO DA SAÚDE
  • DIREITO DO CONSUMIDOR
  • DIREITO DO TRABALHO
  • DIREITO ASSISTENCIAL
  • DIREITO ADMINISTRATIVO E OUTRAS MATÉRIAS DE DIREITO PÚBLICO
  • DIREITO AMBIENTAL
  • DIREITO ELEITORAL
  • DIREITO INTERNACIONAL
  • DIREITO MARÍTIMO
  • DIREITO TRIBUTÁRIO
  • DIREITO PENAL
  • DIREITO PENAL MILITAR
  • DIREITO PREVIDENCIÁRIO
  • DIREITO PROCESSUAL CIVIL E DO TRABALHO
  • QUESTÕES DE ALTA COMPLEXIDADE, GRANDE IMPACTO E REPERCUSSÃO
  • REGISTROS PÚBLICOS

​
Secrecy Levels (secrecy_level)

Procedural secrecy classification system (integer from 0 to 5):
LevelDescriptionPermitted Access
0PublicGeneral public access.
1Judicial secrecyParties and their associated lawyers.
2Restricted (Court staff)Judicial unit staff and parties.
3Confidential (Chambers)Magistrates, court clerks, and advisors.
4Confidential (Magistrates and Clerks)Only magistrates and court clerks.
5Absolute secrecyExclusive to the magistrate in charge of the lawsuit.
Lawsuits with secrecy level > 0 may return limited payloads or payloads with obfuscated data, depending on the originating court and the credentials (Vault) used in the search.

​
Types of Justice (justice_description)

Classification of Brazilian Judiciary bodies:
  • SUPREMO TRIBUNAL FEDERAL
  • CONSELHO NACIONAL DE JUSTIÇA
  • SUPERIOR TRIBUNAL DE JUSTIÇA
  • TRIBUNAL REGIONAL FEDERAL
  • JUSTIÇA DO TRABALHO
  • JUSTIÇA ELEITORAL
  • JUSTIÇA MILITAR DA UNIÃO
  • JUSTIÇA MILITAR ESTADUAL
  • JUSTIÇA ESTADUAL

​
Lifecycle: Status vs. Situation

The API returns two similar fields, but with distinct purposes, to indicate the health of the lawsuit.

​
1. Global Status (status)

Macro, standardized view of the lawsuit, ideal for filters and dashboards:
ValueDescriptionBehavior on Judit
ATIVOLawsuit running normally.The crawler keeps collecting steps on every tracker run.
FINALIZADOLawsuit concluded or closed.The crawler still monitors (in case the court reopens), but movements are rare.

​
2. Granular Situation (situation)

More specific and variable status, captured directly from the court’s header:
ValueDescriptionBehavior on Judit
INICIALLawsuit recently filed.Tends to generate many updates in the first days — a low tracker recurrence is recommended.
SENTENÇALawsuit with a judgment issued.Critical point — common target for notification_filters.step_terms.
EXECUÇÃO OU CUMPRIMENTOLawsuit in execution/collection phase.Financial events (seizures, blocks) appear in the steps.
TRÂNSITO JULGADO OU EM ACORDOFinal decision with no further appeal possible.Little follow-up activity; a high recurrence (e.g. 30 days) is enough.
RECURSOLawsuit awaiting appeal judgment.Often generates new lawsuit_cnj at the 2nd instance.
ARQUIVADOLawsuit permanently archived.The crawler keeps collecting, but rarely brings news.
SUSPENSOProceedings temporarily halted.May return to ATIVO — keep the tracker active.
SOBRESTADOAwaiting decision from a superior court.Usually moves together with the lead-case decision at STF/STJ.
CANCELADOFiling canceled.The court removed the lawsuit — Judit marks it invalid on future runs.

​
Poles and Person Types (side and person_type)

When iterating over the parties arrays (whether in Lawsuits, Warrants, or Executions), you will encounter these classifications:

​
Procedural Pole (side)

Which side of the dispute the person is on.
  • ACTIVE: Active Pole (the one filing the action).
  • PASSIVE: Passive Pole (the one against whom the action is filed).
  • INTERESTED: Third parties or interested parties.
  • UNKNOWN: Not specified by the court.

​
Specific Role (person_type)

The exact legal qualification of the party. Common examples:
  • AUTOR / REQUERENTE / EXEQUENTE
  • RÉU / REQUERIDO / EXECUTADO / REEDUCANDO
  • ADVOGADO / DEFENSOR PÚBLICO
  • TESTEMUNHA / PERITO

​
Phases and Case Updates

​
Lawsuit Phases (phase)

  • CONHECIMENTO
  • EXECUÇÃO
  • RECURSO
  • FASE (Generic value used when the court does not specify the exact phase)

​
Case Update Codes (step_type)

The codes map to the CNJ Unified Procedural Table (TPU). Examples:
  • DISTRIBUIÇÃO
  • CITAÇÃO
  • CONTESTAÇÃO
  • SENTENÇA
  • RECURSO
  • ARQUIVAMENTO

​
Other Useful Enumerations

​
Brazilian States (state)

The API uses the 2-letter uppercase state acronym (UF) standard: AC, AL, AP, AM, BA, CE, DF, ES, GO, MA, MT, MS, MG, PA, PB, PR, PE, PI, RJ, RN, RS, RO, RR, SC, SP, SE, TO.

​
Document Types (documents)

Types of identifiers present in the documents arrays of parties or entities:
  • CPF: Individual (natural person).
  • CNPJ: Legal entity.
  • RG: General Registry (Brazilian ID card).
  • OAB: Bar Association registration (usually accompanied by the state acronym, e.g., OAB/SP).

​
Practical Usage Examples

Below, see the correct way to validate data by accessing the response_data object of a lawsuit.

​
1. Type Validation

// Example: Validating the status received from the API
const lawsuit = response.json(); // Root object

const validStatuses = ['ATIVO', 'FINALIZADO'];
const currentStatus = lawsuit.response_data.status; // ✅ Correct access

if (validStatuses.includes(currentStatus)) {
    console.log("Status recognized:", currentStatus);
}

​
2. Array Filtering

// Example: Filter lawsuits from a list that are only Public
const publicLawsuits = lawsuitsArray.filter(
  lawsuit => lawsuit.response_data.secrecy_level === 0
);

// Example: Filter only lawsuits from the State of SP
const spLawsuits = lawsuitsArray.filter(
  lawsuit => lawsuit.response_data.state === 'SP'
);

​
Next Steps

  • 👉 Search Lawsuits: Use these enumerations as filter parameters in your searches.
  • 👉 Arrest Warrant: See the schema for the arrest warrant object.
  • 👉 Penal Execution: See the schema for penal executions and related enums.
  • 👉 Glossary: Legal and technical terms used by the Judit API.