Visualizar por ID

Este endpoint permite consultar o status e o resultado de uma consulta previamente criada, utilizando o requestId gerado no momento da criação da requisição.

Por meio deste endpoint é possível:

• Acompanhar o status do processamento
• Verificar se a consulta foi concluída
• Obter os dados coletados quando disponíveis

Requisição

GET https://api.consulta.codilo.com.br/v1/request/{requestId}

Parâmetros

Nome	Tipo	Obrigatório	Descrição
requestId	string	true	Identificador único gerado na criação da consulta

Exemplos de Requisição

cURL

curl -X GET "https://api.consulta.codilo.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"

Python

import requests

headers = {
    "Authorization": "Bearer SEU_ACCESS_TOKEN"
}

response = requests.get(
    "https://api.consulta.codilo.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
    headers=headers
)

print(response.json())

PHP

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.consulta.codilo.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer SEU_ACCESS_TOKEN",
]);

$response = curl_exec($ch);

curl_close($ch);

echo $response;

Node.js

fetch('https://api.consulta.codilo.com.br/v1/request/6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer SEU_ACCESS_TOKEN',
  },
})
  .then(response => response.json())
  .then(data => console.log(data));

Status da Consulta

A propriedade status indica o estado atual do processamento:

Status	Descrição
pending	A consulta está em processamento
success	Dados encontrados e coletados com sucesso
warning	Nenhum dado encontrado (processo inexistente, migrado, segredo de justiça, etc.)
error	Erro durante a coleta (indisponibilidade do tribunal ou falha interna)

Exemplo de Resposta (200 - OK)

Sucesso

{
  "success": true,
  "type": "lawsuits",
  "requested": {
    "id": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
    "status": "success",
    "source": "courts",
    "platform": "esaj",
    "query": "principal",
    "court": "tjsp",
    "search": "tjsp",
    "param": {
      "key": "cnj",
      "value": "0002796-14.2013.8.26.0323"
    },
    "respondedAt": "2022-03-08T00:26:37.603Z",
    "createdAt": "2022-03-08T00:26:26.088Z"
  },
  "info": {
    "source": "Consulta de Processos",
    "platform": "eSAJ da Justiça Estadual",
    "search": "Tribunal de Justiça de São Paulo",
    "query": "Consulta de Processos de 1º Grau",
    "paramKey": "Numeração Única"
  },
  "data": [
    {
      "cover": [
        {
          "description": "Processo",
          "value": "0002796-14.2013.8.26.0323"
        }
      ],
      "properties": {
        "number": "0002796-14.2013.8.26.0323",
        "class": "Embargos à Execução",
        "origin": "Foro de Lorena",
        "cnj": "0002796-14.2013.8.26.0323",
        "value": "23139.43"
      },
      "people": [],
      "steps": []
    }
  ]
}

Status Codes

Status	Significado	Descrição
200	OK	Consulta retornada com sucesso
401	Unauthorized	Token inválido, expirado ou não informado
429	Too Many Requests	Limite de requisições excedido