Create a request

curl --request POST \
  --url https://requests.prod.judit.io/requests \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "search": {
    "search_type": "<string>",
    "search_key": "<string>",
    "response_type": "<string>",
    "cache_ttl_in_days": 123,
    "should_search_branches": true,
    "search_params": {
      "lawsuit_instance": 123,
      "masked_response": true,
      "filter": {
        "side": "<string>",
        "distribution_date_gte": "<string>",
        "amount_gte": 123,
        "amount_lte": 123,
        "tribunals": {
          "keys": [
            {}
          ],
          "not_equal": true
        },
        "subject_codes": {
          "keys": [
            {}
          ],
          "not_equal": true
        },
        "classification_codes": {
          "keys": [
            {}
          ],
          "not_equal": true
        }
      },
      "credential": {
        "customer_key": "<string>"
      }
    }
  }
}
'

{
    "request_id": "00000000-0000-0000-0000-000000000001",
    "search": {
        "search_type": "lawsuit_cnj",
        "search_key": "9999999-99.9999.9.99.9999",
        "search_params": {}
    },
    "origin": "api",
    "origin_id": "00000000-0000-0000-0000-000000000002",
    "status": "pending",
    "tags": {},
    "created_at": "2023-10-18T18:36:58.775Z",
    "updated_at": "2023-10-18T18:36:58.775Z"
}

POST

requests

Create a request

curl --request POST \
  --url https://requests.prod.judit.io/requests \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "search": {
    "search_type": "<string>",
    "search_key": "<string>",
    "response_type": "<string>",
    "cache_ttl_in_days": 123,
    "should_search_branches": true,
    "search_params": {
      "lawsuit_instance": 123,
      "masked_response": true,
      "filter": {
        "side": "<string>",
        "distribution_date_gte": "<string>",
        "amount_gte": 123,
        "amount_lte": 123,
        "tribunals": {
          "keys": [
            {}
          ],
          "not_equal": true
        },
        "subject_codes": {
          "keys": [
            {}
          ],
          "not_equal": true
        },
        "classification_codes": {
          "keys": [
            {}
          ],
          "not_equal": true
        }
      },
      "credential": {
        "customer_key": "<string>"
      }
    }
  }
}
'

{
    "request_id": "00000000-0000-0000-0000-000000000001",
    "search": {
        "search_type": "lawsuit_cnj",
        "search_key": "9999999-99.9999.9.99.9999",
        "search_params": {}
    },
    "origin": "api",
    "origin_id": "00000000-0000-0000-0000-000000000002",
    "status": "pending",
    "tags": {},
    "created_at": "2023-10-18T18:36:58.775Z",
    "updated_at": "2023-10-18T18:36:58.775Z"
}

object

Show properties

search_type

string

required

Defines the type of entity you want to search: cpf, cnpj, oab, lawsuit_cnj, or lawsuit_id.

search_key

string

required

Lawsuit number (CNJ code), CPF, CNPJ, or OAB.

response_type

string

Defines the type of the search response data: lawsuit, parties, attachments, step, or lawsuits.

cache_ttl_in_days

integer

Defines how many days the search result can still be considered a valid cache.

should_search_branches

boolean

When true, a separate request will be created for each branch (subsidiary) linked to the provided CNPJ. All generated requests are associated with the original request through the origin_id field.

search_params

object

Show properties

lawsuit_instance

integer

Defines the instance in which you want to search the lawsuit.

masked_response

boolean

Defines whether the response will come minified. This parameter is used exclusively for simple or complete document queries.

filter

object

Show properties

side

string

Defines the types of participants in the lawsuit: Passive or Active.

distribution_date_gte

date

Returns searches with a distribution date greater than or equal to the one provided.

amount_gte

number

Returns searches whose case value is greater than the value provided.

amount_lte

number

Returns searches whose case value is less than the value provided.

tribunals

object

Show properties

keys

array

Filters lawsuits with (or without) these codes.

not_equal

boolean

Determines whether the filter matches lawsuits that contain or do not contain the provided codes.

subject_codes

object

Show properties

keys

array

Filters lawsuits with (or without) these codes.

not_equal

boolean

Determines whether the filter matches lawsuits that contain or do not contain the provided codes.

classification_codes

object

Show properties

keys

array

Filters lawsuits with (or without) these codes.

not_equal

boolean

Determines whether the filter matches lawsuits that contain or do not contain the provided codes.

credential

object

Show properties

customer_key

string

Lets you pass the client’s key to access the correct credentials vault. If not provided, the API will try to find a credential registered with an empty customer_key.

{
    "request_id": "00000000-0000-0000-0000-000000000001",
    "search": {
        "search_type": "lawsuit_cnj",
        "search_key": "9999999-99.9999.9.99.9999",
        "search_params": {}
    },
    "origin": "api",
    "origin_id": "00000000-0000-0000-0000-000000000002",
    "status": "pending",
    "tags": {},
    "created_at": "2023-10-18T18:36:58.775Z",
    "updated_at": "2023-10-18T18:36:58.775Z"
}

Authorizations

api-key

string

header

required

Body

application/json

object

Show child attributes

Get a request by id

Requests

Responses

Registration Data Flow

Tracking

JUDIT Cache Query

Attachment Access

Credentials Vault

Create a request

Authorizations

Body