Sumário de Processos

Este endpoint devolve um sumário dos processos judiciais existentes para o CPF ou CNPJ consultado, agrupando as contagens por tribunal, por segmento de justiça e por ano.

É a consulta de contagem: ela não traz a capa nem as movimentações dos processos. Para o detalhe de cada processo, use Processos.

🚧 O data é repassado do provedor, sem transformação

A API não remonta o corpo desta resposta: o que o provedor devolve dentro de data é entregue como está, dentro do envelope padrão. Os nomes dos campos são os do provedor, e não há conversão de tipo no caminho — as tabelas desta página descrevem os campos, mas não fixam tipos.

Request

GET /lawsuits-summary/v1

A versão é obrigatória na URL

Não existe rota /lawsuits-summary sem versão. Chamar sem a versão devolve 404 antes mesmo da autenticação.

Parâmetros

Parâmetro	Descrição	Obrigatório
taxId	CPF ou CNPJ da parte do processo	Sim
version	Versão da API na URL. Só v1 existe.	Sim

O taxId aceita CPF ou CNPJ, com ou sem máscara (123.456.789-09 ou 12345678909). A máscara é removida antes da consulta. Um documento que não passa na validação do dígito verificador devolve 422, e a ausência do taxId também.

Parâmetros de query desconhecidos são ignorados

Esta rota lê apenas taxId. Qualquer outro parâmetro na URL não gera erro: ele é simplesmente ignorado, e a resposta vem 200 normalmente.

Headers

Authorization: ApiKey <sua-chave-de-api>

Exemplo Request

GET /lawsuits-summary/v1?taxId=12345678909

curl -i -G 'https://api.nxcd.app/lawsuits-summary/v1' \
  --header 'Authorization: ApiKey SUA_CHAVE_AQUI' \
  --data-urlencode 'taxId=12345678909'

Consulta por CNPJ:

curl -i -G 'https://api.nxcd.app/lawsuits-summary/v1' \
  --header 'Authorization: ApiKey SUA_CHAVE_AQUI' \
  --data-urlencode 'taxId=11.222.333/0001-81'

Response

O envelope é o padrão da API:

Campo	Descrição	Tipo
id	Identificador único da requisição	String
version	Versão da API que atendeu a chamada	String
data	Lista com o sumário devolvido pelo provedor	Object[]
metadata	Objeto com os metadados da requisição	Object
metadata.timeSpent	Tempo da requisição, em milissegundos	Number

data é uma lista

Mesmo trazendo um único sumário, data vem como lista. Quando o provedor não devolve nada, a API entrega [].

Campos observados dentro de cada item de data:

Campo	Descrição
data[].total	Total de processos encontrados para o documento consultado
data[].totalByCourt	Contagem por tribunal, com a sigla do tribunal como chave
data[].totalByJustice	Contagem por segmento de justiça, com o segmento como chave
data[].totalByYear	Contagem por ano, com o ano como chave

As siglas de tribunal que aparecem em totalByCourt são as mesmas listadas em Tribunal ou Corte, na página de Processos.

Exemplos JSON

Veja um exemplo em JSON da resposta.

Status Code: 200

{
  "id": "3aa55faf-0c97-40f0-a5a2-4a06ba6db92b",
  "version": "v1",
  "data": [
    {
      "total": 84,
      "totalByCourt": {
        "TRT-9": 14,
        "TST": 2,
        "TJ-SC": 51,
        "TJ-SP": 1,
        "STJ": 1,
        "TRT-12": 11,
        "TJ-RS": 3,
        "TJ-RJ": 1
      },
      "totalByJustice": {
        "TST": 2,
        "STJ": 1,
        "JUSTICA DO TRABALHO": 25,
        "JUSTICA ESTADUAL": 56
      },
      "totalByYear": {
        "2012": 4,
        "2011": 2,
        "2010": 2,
        "1998": 7,
        "2009": 1,
        "2008": 3,
        "1997": 1,
        "1995": 1,
        "2005": 1,
        "2004": 1,
        "2003": 2,
        "2002": 1,
        "1999": 13,
        "2001": 2,
        "2000": 4,
        "2022": 2,
        "2021": 2,
        "2020": 2,
        "2019": 3,
        "2018": 8,
        "2017": 5,
        "2016": 2,
        "2015": 5,
        "2014": 5,
        "2013": 5
      }
    }
  ],
  "metadata": {
    "timeSpent": 4833
  }
}

Headers de resposta

Header	Quando aparece
Nextid-ReqId	Em todas as respostas. Traz o identificador da requisição, o mesmo do campo id do corpo.

Erros

Código	Quando ocorre
401 Unauthorized	Chave de API ausente, inválida, ou sem a permissão nextid.bureaus.lawsuitsSummary.
404 Not Found	A versão informada na URL não existe, ou a URL foi chamada sem versão. Só v1 é aceita.
422 Unprocessable Entity	taxId ausente, ou CPF/CNPJ que não passa na validação do dígito verificador.
500 Internal Server Error	Falha inesperada durante o processamento, incluindo falha na consulta ao provedor.

Exemplo de resposta sem o taxId:

Status Code: 422

{
  "id": "3aa55faf-0c97-40f0-a5a2-4a06ba6db92b",
  "error": {
    "statusCode": 422,
    "error": "Unprocessable Entity",
    "message": "The taxId (CPF/CNPJ) parameter is required."
  }
}

Exemplo de resposta com CPF ou CNPJ inválido:

Status Code: 422

{
  "id": "3aa55faf-0c97-40f0-a5a2-4a06ba6db92b",
  "error": {
    "statusCode": 422,
    "error": "Unprocessable Entity",
    "message": "Invalid taxId (CPF/CNPJ)"
  }
}

O formato das respostas de erro está descrito em Códigos HTTP das respostas.

Versões

Versão	Situação	O que muda
v1	Recomendada	Única versão.

Qualquer outro valor no lugar de v1 devolve 404 com a mensagem API version not found.

Endpoint relacionado

• Processos — a capa e as movimentações de cada processo do CPF/CNPJ.