Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

O que é

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/tjsp/consulta-processos-primeiro-grau

URL Base:

https://api.plexi.com.br/

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

Authorization

String

Sim

Chave de API gerada no cadastro no Plexi, prefixada com Bearer

Callback

String

Não

URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body

Nome

Tipo

Obrigatório?

Descrição

cpfCnpj

string

Apenas se não for passado valor em “nome”

CPF ou CNPJ a ser pesquisado. Deve ser informado sem pontuação. Exemplo: 99999999999

nome

string

Apenas se não for passado valor em “cpfCnpj”

Nome a ser pesquisado

pesquisarPorNomeCompleto

boolean

Não

Se ao pesquisar utilizando o “nome” será feito uma busca com o nome completo

Estrutura da resposta

Status

Significado

Descrição

Informações retornadas

201

Created

Solicitação criada

Campo requestId, com o ID da requisição criada.

422

Unprocessable Entity

A solicitação contém erro

Em quais campos houve erro.

Exemplos de retornos quando você faz a requisição:

Status 201

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

Exemplos de retornos do resultado da pesquisa

Valores possíveis do campo “status“

Status

Significado

positivo

Empresa ou pessoa tem registro de processos no TJSP

negativo

Empresa ou pessoa NÃO contém registro de processos no TJSP

erro

Erro ao buscar informações, seja por documento ou outro dado incorreto

Respostas com registro encontrado

{
  "status": "positivo",
  "processos": [
    {
      "foro": "Foro de Piracicaba",
      "numero": "0000000-11.2222.3.4444444",
      "participacao": "Exeqte",
      "nome": "Empresa Ltda",
      "classe": "Cumprimento de sentença",
      "assunto": "Espécies de Contratos",
      "data": "01/01/2010",
      "vara": "3ª Vara Cível"
    }
  ],
  "totalProcessos": 1,
  "mensagem": "Neste retorno estão listados 1 processo de um total de 1.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
  "status": "negativo",
  "processos": [],
  "totalProcessos": 0,
  "mensagem": "Não existem informações disponíveis para os parâmetros informados.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

{
  "status": "erro",
  "mensagem": "Foram encontrados muitos processos para os parâmetros informados. Por favor, refine sua busca.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
  • No labels