Consulta por Documento

Para realizar a consulta por documento, é necessário criar uma requisição ao endpoint de consulta correspondente. Essa consulta pode ser realizada em nossa base de dados ou diretamente no tribunal. Vale destacar que os dados disponíveis em nossa base podem estar sujeitos a um atraso de atualização de até 30 dias.

Diferença entre Consulta On-Demand e Consulta Direto na Base de Dados

Para realizar a consulta por documento, é necessário criar uma requisição ao endpoint correspondente. Há duas opções disponíveis para a origem dos dados:

Consulta na Base de Dados:

• Os dados são recuperados diretamente de nossa base de dados. Esta opção oferece respostas mais rápidas, pois não depende de uma nova consulta ao tribunal.

Consulta On Demand:

• A consulta é feita diretamente no tribunal no momento da solicitação. Para utilizar esta opção, o parâmetro on_demand deve ser incluído no payload da solicitação com o valor true. Esta abordagem garante acesso aos dados mais atualizados, realizando comunicação direto com o tribunal.

Payload da Solicitação

A solicitação POST deve incluir um payload com as seguintes propriedades:

search_type: Este campo define o tipo de entidade que será buscada. Os valores possíveis são: cpf, cnpj, oab, name, lawsuit_cnj ou lawsuit_id. Para buscas processuais, utilizaremos especificamente cpf, cnpj ou oab, que correspondem ao número do processo.

• search_key: O número do processo (Código CNJ), CPF, CNPJ, OAB ou Name que você deseja buscar;

• cache_ttl_in_days (opcional): Número inteiro que define até quantos dias o resultado da busca pode considerar um cache válido;

• search_params: Um objeto que contém alguns parâmetros da busca como: - lawsuit_instance (opcional): Este parâmetro permite definir a instância em que deseja buscar o processo; - masked_response Define se a resposta virá minificada. Este parâmetro é aplicável apenas a consultas (simples ou completas) por documento no contexto de busca processual. - masked_response = true: retornará uma consulta completa - masked_response = false: retornará uma consulta simples

  Obs Consulte as condições comerciais desses diferentes tipos de consultas por documento.

Filtros poderão ser adicionados à requisição, permitindo um retorno mais assertivo com base nos valores desejados. Para isso, o parâmetro filter deve ser incluído dentro de search_params, com os seguintes filtros disponíveis:

• filter (opcional): Um objeto que contém os filtros para a busca, como:

• side (opcional): Permite buscar por tipos de participantes do processo, podendo ser: ‘Passive’, ‘Active’, ‘Interested’, ‘Unknown’;

• amount_gte (opcional): Filtra processos com valor da causa maior ou igual ao especificado em amount_gte;

• amount_lte (opcional): Filtra processos com valor da causa menor ou igual ao especificado em amount_lte;

• tribunals (opcional): Um objeto que contém os filtros de tribunais:

  • keys (opcional): Lista de códigos de tribunais disponíveis na lista de tribunais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;
  • not_equal (opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys.

• subject_codes (opcional): Um objeto que contém os filtros de assuntos:

  • contains (opcional): Lista de códigos de assuntos. Restringe a busca a processos que incluam os códigos especificados.
  • not_contains (opcional): Lista de códigos de assuntos. Exclui processos que contenham os códigos especificados.

• classification_codes (opcional): Um objeto que contém os filtros de classes processuais:

  • keys (opcional): Lista de códigos de classes processuais. Este filtro permite restringir a busca a processos que tenham ou não esses códigos específicos;
  • not_equal (opcional): Valor booleano que define se o filtro incluirá ou excluirá os valores especificados em keys.

• distribution_date_gte (opcional): Permite especificar uma data mínima de distribuição. Este filtro localiza processos distribuídos após a data informada.

• credential (opcional): Objeto para o uso do cofre de credenciais:

• customer_key (opcional): Permite passar a chave do usuário cadastrada no cofre de credenciais. Caso não seja informada, a API tentará encontrar uma credencial cadastrada para uma customer_key vazia.

• last_step_date_gte (opcional): Restringe a busca a processos cuja data da última movimentação seja maior que à data fornecida.

• last_step_date_lte (opcional): Restringe a busca a processos cuja data da última movimentação seja menor que à data fornecida.

• party_names (opcional): Lista de nomes que restringe a busca a processos que os contenham em alguma das partes.

  Obs Ao utilizar esse filtro em conjunto com o filtro de Side, o filtro de Side não será considerado para a restrição dessas partes, já que o filtro de Side é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.

• party_documents (opcional): Lista de documentos que restringe a busca a processos que os contenham em alguma das partes.

  Obs Ao utilizar esse filtro em conjunto com o filtro de Side, o filtro de Side não será considerado para a restrição desses documentos, já que o filtro de Side é utilizado para filtrar processos onde a parte principal buscada esteja no lado especificado.

Exemplo da criação da request por documento com filtros:

 curl --location 'https://requests.prod.judit.io/requests' \
 --header 'api-key: <API-KEY>' \
 --header 'Content-Type: application/json' \
 --data '{
     "search": {
         "search_type": "cnpj",
         "search_key": "99.999.999/0009-99",
         "search_params": {
             "filter": {
                 "side": "Passive",
                 "tribunals": {
                     "keys": ["TJBA"],
                     "not_equal": false
                 },
                 "subject_codes": {
                     "contains": ["10433"],
                     "not_contains": ["1120"]
                 },
                 "classification_codes": {
                     "keys": ["985"],
                     "not_equal": false
                 },
                 "last_step_date_gte": "2024-10-10T00:00:00.000Z",
                 "party_names": ["USUÁRIO TESTE"],
                 "party_documents": ["999.999.999.-99"]
             }
         }
     }    
 }
 '

Exemplo da criação da request por documento em nossa base de dados:

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

Exemplo de criação da request por documento diretamente no tribunal, adicionando o parâmetro on_demand:

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
       }
   }
   '

A resposta dessa requisição será um objeto JSON com os dados de criação da Request.

Abaixo, apresentamos um exemplo de resposta da requisição POST de uma busca realizada em nossa base de dados sem filtros aplicados:

{
  "request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
  "search": {
    "search_type": "cpf",
    "search_key": "99999999999",
    "response_type": "lawsuits",
    "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": {}
 }

 curl --request GET
   --url 'https://requests.prod.judit.io/requests/05ee9825-b2b4-480b-b29e-f071ca7d9c72'
   --header 'api-key: SUA-API-KEY'
   --header 'Content-Type: application/json'

Retorno:

{
  "request_id": "05ee9825-b2b4-480b-b29e-f071ca7d9c72",
  "search": {
     "search_type": "cpf",
     "search_key": "99999999999",
     "response_type": "lawsuits",
     "search_params": {
       "filter": {},
       "pagination": {}
     }
  },
  "origin": "api",
  "origin_id": "46fac09a-b34f-4dfd-a24f-b358bf04dfd4",
  "user_id": "82082593-c664-4d7b-b174-2f0dc4791daf",
  "status": "completed",
  "created_at": "2024-02-21T17:33:22.876Z",
  "updated_at": "2024-02-21T17:33:26.316Z",
  "tags": {
     "dashboard_id": null
  }
}

Através da propriedade status é possível saber se a requisição está completa.

Na URL vai o request_id retornado na primeira requisição.

curl --request GET \
  --url 'https://requests.prod.judit.io/responses/?request_id=cb97f8ba-7736-43c7-a961-436b151cd65c&page=1&page_size=10'
  --header 'api-key: SUA-API-KEY'
  --header 'Content-Type: application/json'

{
    "request_status": "completed",
    "page": 1,
    "page_count": 0,
    "all_pages_count": 0,
    "all_count": 0,
    "page_data": []
}

Os parâmetro page e page_size são opcionais, porém necessários para percorrer as páginas com os processos, caso venham mais de uma, o que é comum no caso de consulta por documento.

O significado de cada campo pode ser encontrado no glossário:

https://docs.judit.io/essentials/glossary