Nova Consulta Única

Este endpoint é utilizado para criar uma nova consulta em um tribunal específico.

As consultas mais comuns são realizadas por:

• Número do processo (CNJ)
• Documento da parte (CPF ou CNPJ)
• Nome da parte

Após o envio da requisição, é gerado um identificador único (requestId) juntamente com o status inicial da consulta.

O resultado final poderá ser obtido de duas formas:

• Recebimento via callback
• Consulta posterior utilizando GET /request/{requestId}

Atenção

Antes de utilizar esta rota, consulte a nossa abrangência para verificar plataformas, tribunais e parâmetros disponíveis.

Requisição

POST https://api.consulta.codilo.com.br/v1/request

Parâmetros

Nome	Tipo	Obrigatório	Descrição
source	string	true	Origem da consulta. Valor fixo: courts
platform	string	true	Plataforma do tribunal. Consulte Platform
search	string	true	Identificador do tribunal a ser consultado
query	string	true	Instância da consulta. Consulte Query
makeDownload	boolean	false	Indica se deve retornar links para download de anexos. Default: false
param	object	true	Parâmetros da consulta. Consulte Params
callbacks	array	false	Lista de callbacks para recebimento automático do resultado
format	string	false	Formato de resposta do callback. default: enviará o callback com o status atualizado. allRequests: irá retornar a coleta completa no callback após todas as consultas retornarem status diferente de pending

Exemplos de Requisição

cURL

curl --request POST \
  --url https://api.consulta.codilo.com.br/v1/request \
  --header 'Authorization: Bearer SEU_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "source": "courts",
    "platform": "esaj",
    "search": "tjsp",
    "query": "principal",
    "param": {
      "key": "cnj",
      "value": "0002796-14.2013.8.26.0323"
    },
    "callbacks": []
  }'

Python

import requests

headers = {
    "Authorization": "Bearer SEU_ACCESS_TOKEN",
    "Content-Type": "application/json",
}

payload = {
    "source": "courts",
    "platform": "esaj",
    "search": "tjsp",
    "query": "principal",
    "param": {
        "key": "cnj",
        "value": "0002796-14.2013.8.26.0323"
    },
    "callbacks": []
}

response = requests.post(
    "https://api.consulta.codilo.com.br/v1/request",
    headers=headers,
    json=payload
)

print(response.json())

PHP

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.consulta.codilo.com.br/v1/request');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer SEU_ACCESS_TOKEN",
    "Content-Type: application/json",
]);

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    "source" => "courts",
    "platform" => "esaj",
    "search" => "tjsp",
    "query" => "principal",
    "param" => [
        "key" => "cnj",
        "value" => "0002796-14.2013.8.26.0323"
    ],
    "callbacks" => []
]));

$response = curl_exec($ch);

curl_close($ch);

echo $response;

Node.js

fetch('https://api.consulta.codilo.com.br/v1/request', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer SEU_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    source: 'courts',
    platform: 'esaj',
    search: 'tjsp',
    query: 'principal',
    param: {
      key: 'cnj',
      value: '0002796-14.2013.8.26.0323',
    },
    callbacks: [],
  }),
})
  .then(response => response.json())
  .then(data => console.log(data));

Resposta de Sucesso

200 - OK

{
  "success": true,
  "data": {
    "id": "6bd157fd-31ef-40a7-bd6b-b2b1a6d0115c",
    "status": "pending",
    "source": "courts",
    "platform": "esaj",
    "query": "principal",
    "court": "tjsp",
    "search": "tjsp",
    "param": {
      "key": "cnj",
      "value": "0002796-14.2013.8.26.0323"
    },
    "respondedAt": null,
    "createdAt": "2022-03-08T00:26:26.088Z"
  }
}

Status Codes

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

Callbacks

Caso informado, a ferramenta enviará automaticamente o resultado final para os endpoints configurados.

Nome	Tipo	Obrigatório	Descrição
method	string	true	Método HTTP utilizado no callback (ex: POST)
url	string	true	URL que receberá os dados da consulta