Judit API

https://docs.judit.io/
Admin
Judit API is a comprehensive platform for automating judicial queries in Brazil, providing...
Tokens:196,903
Snippets:637
Trust Score:6.3
Update:7 months ago
Show doc for...
Tokens:
Raw
### Consult All Monitorings with GET Request (Bash)

Source: https://docs.judit.io/tracking/tracking

This example demonstrates how to retrieve a list of all monitorings using a GET request to the /tracking endpoint. It shows how to specify pagination parameters like 'page' and 'page_size', and includes a placeholder for the API key. The response will be a paginated list of monitoring objects.

```bash
curl -X GET "https://tracking.prod.judit.io/tracking?page=1&page_size=10" \
-H "api-key: YOUR_API_KEY"
```

--------------------------------

### Consult Specific Monitoring Information with GET Request (Bash)

Source: https://docs.judit.io/tracking/tracking

This example shows how to retrieve detailed information about a specific monitoring using a GET request to the /tracking/{monitoramento} endpoint. The {monitoramento} path parameter should be replaced with the actual ID of the monitoring. An API key is required for authentication.

```bash
curl -X GET "https://tracking.prod.judit.io/tracking?tracking_id=15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9" \
-H "api-key: YOUR_API_KEY"
```

--------------------------------

### Configure and Use API Key in Python

Source: https://docs.judit.io/introduction/authentication

Provides a Python example for configuring and using the Judit API Key. It demonstrates fetching the key from environment variables and including it in request headers using the `requests` library.

```python
import os
import requests

# Configurar API Key
api_key = os.getenv('JUDIT_API_KEY')

# Headers padrão
headers = {
    'api-key': api_key,
    'Content-Type': 'application/json'
}

# Fazer requisição
response = requests.get(
    'https://requests.prod.judit.io/requests',
    headers=headers
)
```

--------------------------------

### Webhook Notification Example

Source: https://docs.judit.io/tracking/tracking

Example structure of a webhook notification received for monitoring events.

```APIDOC
## Webhook Notification

### Description
Webhooks are used to notify your system about changes or events related to monitorings. This section provides an example of the payload structure for such notifications.

### Request Body Example
```json
{
  "_id": {
    "$oid": "65f0efe046ad3bda5b27be2d"
  },
  "callback_id": "be1406d9-d62d-402d-8e0e-8684044645de",
  "event_type": "response_created",
  "reference_type": "tracking",
  "reference_id": "8744cfea-f9d4-4e83-801e-bc05003ebf6b",
  "user_id": "ac98336e-c493-4609-a058-cf7114f7a2ed",
  "webhook_id": "2f82201d-1439-436d-8c6a-2e6b3e36a54f",
  "payload": {
    "request_id": "7d50b66c-3e86-4d0b-95af-5ff7561d18ff",
    "response_id": "12576767-d3ea-4ea2-8805-6f2a73ef3439",
    "response_type": "lawsuit",
    "response_data": {
      "code": "9999999-99.9999.9.99.9999",
      "justice": "8",
      "tribunal": "05",
      "instance": 1,
      "distribution_date": "2024-01-17T15:43:39.000Z",
      "judge": "AUGUSTO YUZO JOUTI",
      "tribunal_acronym": "TJBA",
      "secrecy_level": 0,
      "tags": {
        "crawl_id": "f9b29daf-4cd4-48e9-97cd-0cee91400765"
      },
      "subjects": [
        {
          "code": "7779",
          "name": "INDENIZAÇÃO POR DANO MORAL"
        },
        {
          "code": "6220",
          "name": "RESPONSABILIDADE DO FORNECEDOR"
        },
        {
          "code": "1156",
          "name": "DIREITO DO CONSUMIDOR"
        }
      ]
    }
  }
}
```
```

--------------------------------

### Example API Response Structure

Source: https://docs.judit.io/tracking/tracking-custom

Provides an example of the JSON structure returned when querying for monitoring response content. This includes request status, pagination details, and a list of 'page_data' containing specific lawsuit information such as case number, parties involved, and court details.

```json
{
    "request_status": "completed",
    "page": 1,
    "page_count": 1,
    "all_pages_count": 1,
    "all_count": 2,
    "page_data": [
        {
            "request_id": "8534hyt6ujk-71d5-48a7-a8f1-ad61b02ff461",
            "response_id": "26098ui81f-e0ed-4d41-8f43-4c548d8799bb",
            "origin": "api",
            "origin_id": "8534oiklj89-71d5-48a7-a8f1-ad61b02ff461",
            "response_type": "lawsuit",
            "response_data": {
                "amount": 17456.15,
                "attachments": [],
                "classifications": [
                    {
                        "code": "1116",
                        "name": "EXECUÇÃO FISCAL"
                    }
                ],
                "code": "6666666-66.2025.6.66.6666",
                "county": "CAPITAL 12 VARA FAZ PUBLICA",
                "city": "RIO DE JANEIRO",
                "state": "RJ",
                "area": "NÃO INFORMADO",
                "justice_description": "JUSTIÇA ESTADUAL",
                "created_at": "2025-01-27T16:09:19.112Z",
                "updated_at": "2025-02-04T13:41:08.013Z",
                "metadata": {},
                "courts": [
                    {
                        "code": "79705",
                        "name": " CAPITAL 17 FAZ PUBLICA"
                    }
                ],
                "crawler": {
                    "source_name": "JTJ - BR - Document / Lawsuit - Auth",
                    "crawl_id": "e602ad2b-ce2a-4c70-804d-df2febbb935a",
                    "weight": 0,
                    "updated_at": "2025-02-04T13:40:48.782Z"
                },
                "distribution_date": "2025-01-24T17:08:03.000Z",
                "free_justice": false,
                "instance": 1,
                "justice": "8",
                "last_step": {
                    "lawsuit_cnj": "6666666-66.2025.8.19.66666",
                    "lawsuit_instance": 1,
                    "private": false,
                    "step_id": "5d93c333",
                    "step_date": "2025-01-27T10:30:20.000Z",
                    "content": "Expedição de Carta pelo Correio - 1 carta",
                    "step_type": "60",
                    "tags": {
                        "crawl_id": "e602ad2b-ce2a-4c70-804d-df2febbb935a"
                    },
                    "steps_count": 1
                },
                "name": "ESTADO DO RIO DE JANEIRO X BANCO BV S A",
                "parties": [
                    {
                        "not_contains": [],
                        "_id": "67a246c76efb879208114303"
                    },
                    {
                        "classification_codes": {
                            "keys": [
                                "1116",
                                "12785"
                            ],
                            "not_equal": false,
                            "_id": "67a246c76efb879208114302"
                        },
                        "party_names": [],
                        "party_documents": [
                            "99.999.999/0009-99",
                            "88.888.888/0008-88"
                        ]
                    }
                ]
            },
            "pagination": {}
        }
    },
    "tracked_items_count": 0,
    "tracked_items_steps_count": 0,
    "tags": {
        "dashboard_id": null
    },
    "created_at": "2025-02-04T16:56:39.158Z",
    "updated_at": "2025-02-04T16:56:39.158Z"
    }
```

--------------------------------

### Check Request Status - Method 2 Response Example (JSON)

Source: https://docs.judit.io/requests/request-document

An example of the response structure when using the second method to check the status of an asynchronous data lake request. This response focuses on the request status and pagination details of the responses.

```json
{
    "request_status": "completed",
    "page": 1,
    "page_count": 4,
    "all_pages_count": 1,
    "all_count": 4,
    "page_data": [
        // Resposta da requisição
    ]
}
```

--------------------------------

### Example API Response for Request Creation (JSON)

Source: https://docs.judit.io/requests/request-document

An example JSON response received after successfully creating a request via the Judit.io API without any filters applied. This response includes details about the request, search parameters, and initial status.

```json
{
"request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
"search": {
    "search_type": "cpf",
    "search_key": "99999999999",
    "response_type": "lawsuit",
    "search_params": {
    "filter": {},
    "pagination": {}
    }
},
"origin": "api",
"origin_id": "8c8bc14b-9f46-4e52-bc05-25a8af855690",
"user_id": "6dc91e78-400e-489c-b30c-61789e323d7c",
"status": "pending",
"created_at": "2024-02-16T13:14:09.645Z",
"updated_at": "2024-02-16T13:14:09.645Z",
"tags": {}
}
```

--------------------------------

### GET /tracking - Query All Monitorings

Source: https://docs.judit.io/tracking/tracking

Retrieve all your monitorings with optional parameters for pagination and filtering.

```APIDOC
## GET /tracking

### Description
Retrieves a list of all monitorings associated with the user. Supports pagination and filtering by search type, search key, and status.

### Method
GET

### Endpoint
/tracking

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Specifies the page number for the results.
- **page_size** (integer) - Optional - Defines the maximum number of results per page.
- **search_type** (string) - Optional - Filters monitorings by type (e.g., 'cpf', 'cnpj', 'oab', 'lawsuit_cnj', 'name', 'rji').
- **search_key** (string) - Optional - Filters monitorings by a specific key related to CPF, CNPJ, OAB, or lawsuit number.
- **status** (string or array of strings) - Optional - Filters monitorings by status (e.g., 'created', 'updating', 'updated', 'paused', 'deleted'). Can accept a single status or an array of statuses.

### Request Example
```bash
curl -X GET "https://tracking.prod.judit.io/tracking?page=1&page_size=10" \
-H "api-key: YOUR_API_KEY"
```

### Response
#### Success Response (200)
- **Array of monitoring objects**: Each object contains details about a specific monitoring.

#### Response Example
```json
[
  {
    "tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
    "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
    "status": "updated",
    "recurrence": 1,
    "search": {
      "search_type": "lawsuit_cnj",
      "search_key": "9999999-99.9999.9.99.9999",
      "response_type": "lawsuit",
      "search_params": {
        "filter": {},
        "pagination": {}
      }
    },
    "tracked_items_count": 0,
    "tracked_items_steps_count": 0,
    "tags": {},
    "created_at": "2024-02-21T18:26:38.499Z",
    "updated_at": "2024-02-21T18:26:38.499Z"
  }
]
```
```

--------------------------------

### Judit API Configuration Class in Python

Source: https://docs.judit.io/introduction/authentication

This Python class, `JuditConfig`, manages API configuration based on the specified environment. It dynamically retrieves API keys from environment variables and provides headers for API requests. An example demonstrates its usage for making a GET request.

```python
class JuditConfig:
    def __init__(self, environment='production'):
        self.environment = environment
        self.api_key = self._get_api_key()
        self.base_url = 'https://requests.prod.judit.io'
        
    def _get_api_key(self):
        key_name = f'JUDIT_API_KEY_{self.environment.upper()}'
        api_key = os.getenv(key_name)
        
        if not api_key:
            raise ValueError(f"API Key não encontrada: {key_name}")
            
        return api_key
    
    @property
    def headers(self):
        return {
            'api-key': self.api_key,
            'Content-Type': 'application/json'
        }

# Uso
config = JuditConfig('production')
response = requests.get(f"{config.base_url}/requests", 
    headers=config.headers)
```

--------------------------------

### Environment Variable Setup

Source: https://docs.judit.io/introduction/quickstart

Instructions on how to set up your environment variables for API key and base URL.

```APIDOC
## Environment Variables

### Description
Configure these environment variables before making any API requests.

### Method
N/A

### Endpoint
N/A

### Parameters
#### Environment Variables
- **JUDIT_API_KEY** (string) - Required - Your valid API key for authentication.
- **JUDIT_BASE_URL** (string) - Required - The base URL for the Judit API requests.

### Request Example
```bash
export JUDIT_API_KEY="sua-api-key-aqui"
export JUDIT_BASE_URL="https://requests.prod.judit.io"
```
```

--------------------------------

### Configure API Key Environment Variable in Docker

Source: https://docs.judit.io/introduction/authentication

Shows how to manage the `JUDIT_API_KEY` environment variable within Docker configurations, including Dockerfile and docker-compose.yml examples.

```docker
# Dockerfile
ENV JUDIT_API_KEY=""

# docker-compose.yml
environment:
  - JUDIT_API_KEY=${JUDIT_API_KEY}
```

--------------------------------

### Use .env File for API Key in Development (Bash)

Source: https://docs.judit.io/introduction/authentication

Demonstrates how to use a `.env` file to store sensitive information like `JUDIT_API_KEY` and `JUDIT_BASE_URL` for development environments.

```bash
# .env
JUDIT_API_KEY=sua-api-key-aqui
JUDIT_BASE_URL=https://requests.prod.judit.io
```

--------------------------------

### Configure Production Environment Settings in Python

Source: https://docs.judit.io/introduction/authentication

This Python code snippet demonstrates how to set up configuration for a production environment. It retrieves the API key from environment variables and defines the base URL and other connection parameters. This is typically used in a configuration file.

```python
# config/production.py
import os

API_KEY = os.getenv('JUDIT_API_KEY')
BASE_URL = 'https://requests.prod.judit.io'
TIMEOUT = 10
RETRY_ATTEMPTS = 3
```

--------------------------------

### Retrieve Results via API (cURL, Python, JavaScript, PHP, Go)

Source: https://docs.judit.io/introduction/quickstart

This snippet demonstrates how to retrieve results from the Judit.io API once a process status is 'completed'. It includes examples for cURL, Python, JavaScript, PHP, and Go, showing how to make a GET request to the /responses endpoint with pagination and authentication.

```bash
curl -X GET "$JUDIT_BASE_URL/responses?page=1" \
    -H "api-key: $JUDIT_API_KEY"
```

```python
# Obter resultados
if status_data['status'] == 'completed':
    results_response = requests.get(f"{base_url}/responses", 
                                   headers=headers,
                                   params={'page': 1})
    results = results_response.json()
    
    print("Processos encontrados:")
    for item in results.get('page_data', []):
        print(f"- {item}")
```

```javascript
// Obter resultados
if (statusData.status === 'completed') {
    const resultsResponse = await fetch(`${baseUrl}/responses?page=1`, {
        headers: headers
    });
    const results = await resultsResponse.json();
    
    console.log('Processos encontrados:');
    results.page_data?.forEach(item => {
        console.log(`- ${JSON.stringify(item)}`);
    });
}
```

```php
<?php
// Obter resultados
if ($statusData['status'] === 'completed') {
    $resultsUrl = $baseUrl . '/responses?page=1';
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $resultsUrl);
    curl_setopt($ch, CURLOPT_HTTPHEADER, [
        'api-key: ' . $apiKey
    ]);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    
    $resultsResponse = curl_exec($ch);
    $results = json_decode($resultsResponse, true);
    
    echo "Processos encontrados:\n";
    foreach ($results['page_data'] ?? [] as $item) {
        echo "- " . json_encode($item) . "\n";
    }
    
    curl_close($ch);
}
?>
```

```go
// Obter resultados
if statusData["status"] == "completed" {
    resultsURL := baseURL + "/responses?page=1"
    resultsReq, _ := http.NewRequest("GET", resultsURL, nil)
    resultsReq.Header.Set("api-key", apiKey)
    
    resultsResp, err := client.Do(resultsReq)
    if err != nil {
        panic(err)
    }
    defer resultsResp.Body.Close()
    
    resultsBody, _ := io.ReadAll(resultsResp.Body)
    var results map[string]interface{}
    json.Unmarshal(resultsBody, &results)
    
    fmt.Println("Processos encontrados:")
    if pageData, ok := results["page_data"].([]interface{}); ok {
        for _, item := range pageData {
            itemJSON, _ := json.Marshal(item)
            fmt.Printf("- %s\n", string(itemJSON))
        }
    }
}
```

--------------------------------

### Example Monitoring Creation Response

Source: https://docs.judit.io/tracking/tracking-document

This JSON object represents the successful creation of a monitoring request. It includes a unique tracking ID, user ID, status, recurrence settings, search details, and timestamps for creation and updates. The 'hour_range' field indicates the initial query time.

```json
{
"tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
"user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
"status": "created",
"recurrence": 1,
"search": {
  "search_type": "cnpj",
  "search_key": "00.000.000/0001-00",
  "response_type": "lawsuit",
  "search_params": {
    "filter": {},
    "pagination": {}
  }
},
"hour_range": 21,
"tracked_items_count": 0,
"tracked_items_steps_count": 0,
"tags": {},
"created_at": "2024-02-21T18:26:38.499Z",
"updated_at": "2024-02-21T18:26:38.499Z"
}
```

--------------------------------

### List Available Files (curl)

Source: https://docs.judit.io/file-transfer/file-transfer

This example demonstrates how to list available files using the `curl` command. It includes pagination and status filtering. The API supports filtering by description, file type, name, status, and date ranges, along with pagination and ordering parameters.

```bash
curl -H "api-key: SUA_CHAVE_DE_API" \
  "https://lawsuits.prod.judit.io/transfer-file?page=1&page_size=20&status=["completed"]"
```

--------------------------------

### Example Resumed Tracking Response

Source: https://docs.judit.io/tracking/tracking-custom

This is an example JSON response after resuming a tracking entry. The status is updated to 'updated', indicating the tracking is now active. It includes the same tracking details as the paused state.

```json
{
    "tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
    "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
    "status": "updated",
    "recurrence": 1,
    "search": {
        "search_type": "custom",
        "search_key": "custom",
        "response_type": "lawsuit",
        "search_params": {
            "filter": {
                "distribution_date_gte": "2025-02-04T16:56:39.158Z",
                "subject_codes": {
                    "contains": [
                        "5953",
                        "6017",
                        "10394",
                        "12989",
                        "5953",
                        "5951",
                        "5971",
                        "14",
                        "030213"
                    ],
                    "not_contains": [],
                    "_id": "67a246c76efb879208114303"
                },
                "classification_codes": {
                    "keys": [
                        "1116",
                        "12785"
                    ],
                    "not_equal": false,
                    "_id": "67a246c76efb879208114302"
                },
                "party_names": [],
                "party_documents": [
                    "99.999.999/0009-99",
                    "88.888.888/0008-88"
                ]
            },
            "pagination": {}
        }
    },
    "tracked_items_count": 0,
    "tracked_items_steps_count": 0,
    "tags": {},
    "created_at": "2024-02-21T18:26:38.499Z",
    "updated_at": "2024-02-21T18:26:38.499Z"
}
```

--------------------------------

### Start Process Monitoring

Source: https://docs.judit.io/tracking/tracking

Initiate monitoring for a specific process, CPF, CNPJ, OAB, or CNJ code by sending a POST request to the /tracking route.

```APIDOC
## POST /tracking

### Description
Initiates the monitoring of a specific legal process, CPF, CNPJ, OAB, or CNJ code. The API will then automatically check for updates daily across all Brazilian courts.

### Method
POST

### Endpoint
/tracking

### Parameters
#### Request Body
- **document_type** (string) - Required - The type of document to monitor (e.g., "CPF", "CNPJ", "OAB", "CNJ_CODE").
- **document_number** (string) - Required - The number of the document or process to monitor.
- **callback_url** (string) - Optional - A URL to receive notifications when updates are found.

### Request Example
```json
{
  "document_type": "CPF",
  "document_number": "12345678900",
  "callback_url": "https://example.com/webhook"
}
```

### Response
#### Success Response (200)
- **message** (string) - A confirmation message indicating that monitoring has been initiated.
- **tracking_id** (string) - A unique identifier for the monitoring task.

#### Response Example
```json
{
  "message": "Monitoring initiated successfully.",
  "tracking_id": "trk_abc123xyz789"
}
```
```

--------------------------------

### Example Paused Tracking Response

Source: https://docs.judit.io/tracking/tracking-custom

This is an example JSON response received after successfully pausing a tracking entry. It includes details such as tracking ID, user ID, status, and search parameters.

```json
{
    "tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
    "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
    "status": "paused",
    "recurrence": 1,
    "search": {
        "search_type": "custom",
        "search_key": "custom",
        "response_type": "lawsuit",
        "search_params": {
            "filter": {
                "distribution_date_gte": "2025-02-04T16:56:39.158Z",
                "subject_codes": {
                    "contains": [
                        "5953",
                        "6017",
                        "10394",
                        "12989",
                        "5953",
                        "5951",
                        "5971",
                        "14",
                        "030213"
                    ],
                    "not_contains": [],
                    "_id": "67a246c76efb879208114303"
                },
                "classification_codes": {
                    "keys": [
                        "1116",
                        "12785"
                    ],
                    "not_equal": false,
                    "_id": "67a246c76efb879208114302"
                },
                "party_names": [],
                "party_documents": [
                    "99.999.999/0009-99",
                    "88.888.888/0008-88"
                ]
            },
            "pagination": {}
        }
    },
    "tracked_items_count": 0,
    "tracked_items_steps_count": 0,
    "tags": {},
    "created_at": "2024-02-21T18:26:38.499Z",
    "updated_at": "2024-02-21T18:26:38.499Z"
}
```

--------------------------------

### Example Deleted Tracking Response

Source: https://docs.judit.io/tracking/tracking-custom

This is an example JSON response after deleting a tracking entry. The status is set to 'deleted', confirming the removal of the tracking entry. It includes the tracking ID and user ID.

```json
{
    "tracking_id": "15d632c6-a2ab-40c1-bfc5-d8f7bf8d8dd9",
    "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
    "status": "deleted",
    "recurrence": 1,
    "search": {
        "search_type": "custom",
        "search_key": "custom",
        "response_type": "lawsuit",
        "search_params": {
            "filter": {
                "distribution_date_gte": "2025-02-04T16:56:39.158Z"
            }
        }
    }
}
```

--------------------------------

### Consultar Histórico de Monitoramento com Filtro de Data (curl)

Source: https://docs.judit.io/tracking/tracking

Realiza uma requisição GET para a rota `/tracking/{monitoramento}` para obter o histórico de respostas de um monitoramento específico. Permite filtrar os resultados por data usando os parâmetros `created_at_gte` (data inicial) e `created_at_lte` (data final). Requer um `TRACKING_ID` e uma `API-KEY`.

```bash
curl --location 'https://requests.prod.judit.io/responses/tracking/<TRACKING_ID>?order=asc&page=1&page_size=50&created_at_gte=2024-03-05T00%3A00%3A00&created_at_lte=2025-03-11T00%3A00%3A00' \
--header 'api-key: <API-KEY>'
```

--------------------------------

### Example JSON Response for Tracking History

Source: https://docs.judit.io/tracking/tracking-custom

This is an example of the JSON structure returned when querying the tracking response history. It includes pagination details and a list of response data objects, each containing request and response specifics.

```json
{
    "request_status": "completed",
    "page": 1,
    "page_count": 2,
    "all_pages_count": 1,
    "all_count": 2,
    "page_data": [
        {
            "request_id": "644a4759-1ae2-48a4-8b09-76afffc75849393",
            "response_id": "a37ca823-e1d2-4de4-a973-ec9e859d21ed",
            "origin": "tracking",
            "origin_id": "cfb61e6e-f2bd-4375-8c87-373405cac6db",
            "response_type": "lawsuit",
            "response_data": {
                "amount": 13687.36,
                "attachments": [
                    {
                        "attachment_id": "f2f14dca-5b3f-aba2-a9bd95bd367f",
                        "attachment_date": "2025-01-22T15:19:46.000Z",
                        "attachment_name": "id_externo_3",
                        "content": "CÁLCULOS",
                        "extension": "octet-stream",
                        "status": "done",
                        "tags": {
                            "crawl_id": "bf565435-68c6-4b6b-8004-6533cbd0fb8e"
                        },
                        "user_data": null
                    },
                    {
                        "attachment_id": "e26be17f-06ba-9f0c-7fc840e092b1",
                        "attachment_date": "2025-01-22T15:19:46.000Z",
                        "attachment_name": "id_externo_2",
                        "content": "CERTIDÃO DE DÍVIDA ATIVA",
                        "extension": "octet-stream",
                        "status": "done",
                        "tags": {
                            "crawl_id": "bf565435-68c6-4b6b-8004-6533cbd0fb8e"
                        },
                        "user_data": null
                    },
                    {
                        "attachment_id": "54e833a9-58a3-9484-0e6e1cb6c457",
                        "attachment_date": "2025-01-22T15:19:46.000Z",
                        "attachment_name": "id_externo_1",
                        "content": "PETIÇÃO INICIAL",
                        "step_id": "ac8ea79b",
                        "extension": "octet-stream",
                        "status": "done",
                        "tags": {
                            "crawl_id": "bf565435-68c6-4b6b-8004-6533cbd0fb8e"
                        },
                        "user_data": null
                    }
                ],
                "classifications": [
                    {
                        "code": "1116",
                        "name": "EXECUÇÃO FISCAL"
                    }
                ],
                "code": "3000133-12.2025.8.19.0001",
                "county": "TESTE TRIBUNAL",
                "city": "RIO DE JANEIRO",
                "state": "RJ",
                "area": "NÃO INFORMADO",
                "justice_description": "JUSTIÇA ESTADUAL",
                "created_at": "2025-01-23T16:09:20.134Z",
                "updated_at": "2025-01-24T16:10:56.948Z",
                "metadata": {},
                "courts": [
                    {
                        "code": "7798",
                        "name": "TESTE RETORNO TRIUNAL"
                    }
                ],
                "crawler": {
                    "source_name": "JTJ - BR - Document / Lawsuit - Auth",
                    "crawl_id": "8b485368-4315-4247-8314-a6169aa46e0b",
                    "weight": 0,
                    "updated_at": "2025-01-24T16:10:50.024Z"
                },
                "distribution_date": "2025-01-22T15:19:46.000Z",
                "free_justice": false,
                "instance": 1,
                "justice": "8",
                "last_step": {
                    "lawsuit_cnj": "9999999-99.9999.9.99.9999",
                    "lawsuit_instance": 1,
                    "private": false,
                    "step_id": "91dc5544"
                }
            }
        }
    ]
}
```

--------------------------------

### Create POST Request with On-Demand Tribunal Search (Bash)

Source: https://docs.judit.io/requests/request-document

This example shows how to construct a POST request to the Judit.io API for an on-demand search directly from a tribunal. It includes the 'on_demand: true' parameter in the JSON payload, indicating that the search should be performed in real-time from the tribunal source.

```bash
curl --request POST
    --url 'https://requests.prod.judit.io/requests'
    --header 'Content-Type: application/json'
    --header 'api-key: <API-KEY>'
    --data '{ 
        "search": {
            "search_type": "cpf",
            "search_key": "999.999.999-99",
            "on_demand": true
        }
    }
    '
```

--------------------------------

### Lawsuit Found Response Example (JSON)

Source: https://docs.judit.io/requests/name

An example JSON structure representing a lawsuit found in a tribunal's response. It includes details like the lawsuit code, justice system, tribunal, and crawler information.

```json
{
 "page": 1,
 "page_data": [
     {
         "request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
         "response_id": "e49d2e2c-92ed-4dad-8701-c53a569d675b",
         "response_type": "lawsuit",
         "response_data": {
             "code": "9999999-99.9999.9.99.9999",
             "justice": "8",
             "tribunal": "19",
             "tribunal_acronym": "TJRJ",
             "secrecy_level": 0,
             "tags": {
                 "is_fallback_source": true,
                 "crawl_id": "bd5ca800-9351-4d6e-a238-4690face8a5e"
             },
             "instance": 1,
             "crawler": {
                 "source_name": "JTJ - BR - Document / Lawsuit - Auth"
             }
         }
     }
 ]
}
```

--------------------------------

### Arrest Warrant Response Example (JSON)

Source: https://docs.judit.io/criminal-consultation/warrant

An example of a successful response when querying for an arrest warrant. It includes request details, search parameters, status, and timestamps.

```json
{
	"request_id": "87d9f7bf-0071-41ee-a721-e6e1b4082bc9",
	"search": {
		"search_type": "cpf",
		"search_key": "999.999.999-99",
		"response_type": "warrant",
		"search_params": {
			"filter": {},
			"pagination": {}
		}
	},
	"with_attachments": true,
	"origin": "api",
	"origin_id": "33fad316-cd98-40b9-bcd4-70e3c74ff947",
	"user_id": "6dc91e78-400e-489c-b30c-61789e323d7c",
	"status": "pending",
	"created_at": "2024-03-14T07:35:14.272Z",
	"updated_at": "2024-03-14T07:35:14.272Z",
	"tags": {}
}
```

--------------------------------

### Create Monitoring Request using cURL

Source: https://docs.judit.io/tracking/tracking

Demonstrates how to create a monitoring job using a cURL command. This example sends a POST request to the tracking endpoint with a JSON payload containing recurrence and search details. An API key is required for authentication.

```bash
curl --location 'https://tracking.prod.judit.io/tracking' \
--header 'api-key: <API-KEY>>' \
--header 'Content-Type: application/json' \
--data '{
    "recurrence": 1,
    "search": {
        "search_type": "lawsuit_cnj",
        "search_key": "1111111-04.1111.1.11.1111"
    }
}'
```

--------------------------------

### Lawsuit Object Structure Example (JSON)

Source: https://docs.judit.io/essentialConcepts/lawsuit-object

This JSON object represents the structure of a Lawsuit as returned by an API. It includes details about the case itself, parties involved, procedural steps, and attachments. This serves as a comprehensive example for understanding the data model.

```json
{
  "response_data": {
    "area": "DIREITO CIVIL",
    "name": "Ação de Cobrança",
    "distribution_date": "2024-01-15",
    "instance": "1ª INSTÂNCIA",
    "court": "1ª VARA CÍVEL",
    "secrecy_level": 0,
    "subjects": "COBRANÇA",
    "classifications": "PROCEDIMENTO COMUM",
    "judge": "João Silva Santos",
    "code": "9999999-99.9999.9.99.9999",
    "justice_description": "JUSTIÇA ESTADUAL",
    "county": "SÃO PAULO",
    "tribunal_acronym": "TJSP",
    "city": "SÃO PAULO",
    "state": "SP",
    "situation": "ATIVO",
    "phase": "CONHECIMENTO",
    "status": "INICIAL",
    "amount": "R$ 50.000,00"
  },
  "parties": [
    {
      "name": "EMPRESA XYZ LTDA",
      "main_document": "12.345.678/0001-90",
      "side": "ATIVO",
      "person_type": "AUTOR",
      "documents": ["CNPJ"],
      "lawyers": [
        {
          "name": "Maria Advogada",
          "oab": "OAB/SP 123456"
        }
      ]
    }
  ],
  "steps": [
    {
      "step_date": "2024-01-15",
      "step_type": "DISTRIBUIÇÃO",
      "content": "Processo distribuído para a 1ª Vara Cível",
      "private": false,
      "step_id": "001"
    }
  ],
  "attachments": [
    {
      "attachment_date": "2024-01-15",
      "attachment_name": "Petição Inicial"
    }
  ]
}
```
Tokens:
Raw