Introdução

Bem vindo a documentação da API Loy. Esta documentação tem por finalidade auxiliar na integração com os serviços fornecidos pela Loy.

Todos os dados enviados e recebidos pela API estão/deverão ser em formato JSON (application/json).

Consulta

Para obter qualquer informação sobre um processo, primeiramente é necessário importá-lo para a base Loy.

Importação

Para realizar uma importação processual, é necessário informar o parâmetro do database + token, e no corpo da requisição informar o número do processo (CNJ).

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
token_captura (obrigatório) é o token de acesso da API fornecido pela Loy

Exemplo de requisição

POST
https://api.loylegal.com/v1/{database}/process/capture?token={token_captura}

Exemplo do corpo da requisição

{
    "justices": [
        { "number": "00010714720178160001" },
        { "number": "00005380620198260001" }
    ]
}

Exemplo de resposta

{
  "message": "OK - Processando em background"
}

Capa

Para obter todas as informações da capa processual, basta informar o número do CNJ na requisição.

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
cnj (obrigatório) é o número CNJ do processo

Obs: Se o retorno do campo isWorked for igual à true, significa que a importação ainda está em execução.

Exemplo de requisição

GET
https://api.loylegal.com/v1/{database}/process/00034026020208160069

Exemplo de resposta

{
   "data": {
      "_id": "5e8f3e951b2f6000195694dg",
      "title": "Wenndel Junior Gobato Silva x Banco Bradesco Financiamentos S.A.",
      "typeOfAccess": "Público",
      "judgment": {
         "classIdentifier": "436",
         "justice": "Tribunal de Justiça",
         "instance": "1º Grau",
         "organInstance": "1º Grau",
         "organCourt": "TJ",
         "organState": "PR",
         "organName": "Juizado Especial Cível de Cianorte - Cianorte",
         "organCourtName": "TJPR(Projudi)",
         "organSystem": "PJD",
         "number": "00034026020208160069",
         "className": "Procedimento do Juizado Especial Cível",
         "status": "PROCESSO DISTRIBUÍDO",
      },
      "subjects": [
         {
            "part": {
               "subjectType": "Parte Ativa",
               "people": {
                  "name": "Wenndel Junior Gobato Silva",
                  "federalRegister": "04674250943",
                  "personalType": "Física",
               }
            },
            "advocates": []
         },
         {
            "part": {
               "subjectType": "Parte Passiva",
               "people": {
                  "name": "Banco Bradesco Financiamentos S.A.",
                  "federalRegister": "07207996000150",
                  "personalType": "Jurídica",
               }
            },
            "advocates": [],
         }
      ],
      "topics": [
         {
            "isMain": true,
            "identifier": "10433",
            "name": "DIREITO CIVIL \\ Responsabilidade Civil \\ Indenização por Dano Moral"
         }
      ],
      "magistrateActive": [
         "Stela Maris Perez Rodrigues"
      ],
      "amountOfTheClaim": 1000000,
      "origin": "Automático",
      "situation": "PROCESSO DISTRIBUÍDO",
      "isDigital": true,
      "isWorked": false,
      "createdAt": "2020-04-09T15:26:13.049Z",
      "distributed": "2020-03-25T13:46:22.000Z",
      "filingDate": "2020-03-25T13:46:22.000Z",
      "secretLevel": "Sem Sigilo (Nível 0)"
   }
}

Movimentos

Para listar todas as movimentações de um processo, basta informar o id do processo na URL.

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
id_processo (obrigatório) é o ID do processo retornado na consulta da capa.

Exemplo de requisição

GET
https://api.loylegal.com/v1/{database}/movements/5e8f3e951b2f6000195694dg

Exemplo de resposta

{
  "data": [
    {
      "_id": "5e8f3e951b2f60001956951g",
      "origin": "System",
      "dateTime": "2020-04-09T15:26:13.112Z",
      "description": "Envio de consulta processual",
      "hashCode": "b7c086857cacff28b5f832a43cd0fa37"
    },
    {
      "_id": "5e8f4e845ecb9900194340aa",
      "workload": "5e8f3e951b2f600019569519",
      "origin": "Court",
      "dateTime": "2020-03-31T18:20:54.000Z",
      "identifier": "EXPEDIÇÃO DE CITAÇÃO ONLINE",
      "description": "EXPEDIÇÃO DE CITAÇÃO ONLINE",
      "hashCode": "627489b1feba1651cd4524dbc2c2e361",
      "complement": [
        "Para BANCO BRADESCO FINANCIAMENTOS S.A. com prazo de 10 dias úteis"
      ]
    },
    {
      "_id": "5e8f4e845ecb9900194340ab",
      "workload": "5e8f3e951b2f600019569519",
      "origin": "Court",
      "dateTime": "2020-03-31T18:19:33.000Z",
      "identifier": "EXPEDIÇÃO DE INTIMAÇÃO",
      "description": "EXPEDIÇÃO DE INTIMAÇÃO",
      "hashCode": "f549bce51b3612a0531cb9dbcddbdc9f",
      "complement": [
        "Para Wenndel Junior Gobato Silva com prazo de 5 dias úteis"
      ]
    },
    {
      "_id": "5e8f4e845ecb9900194340ac",
      "workload": "5e8f3e951b2f600019569519",
      "origin": "Court",
      "dateTime": "2020-03-25T13:46:22.000Z",
      "identifier": "JUNTADA DE PETIÇÃO DE INICIAL",
      "description": "JUNTADA DE PETIÇÃO DE INICIAL",
      "hashCode": "add2f47fbb114e85eaf00e27ee31eff8"
    }
  ]
}

Documentos

Para listar todas os documentos de um processo, basta informar o id do processo na URL.

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
id_processo (obrigatório) é o ID do processo retornado na consulta da capa.

Exemplo de requisição

GET
https://api.loylegal.com/v1/{database}/documents/5e8f3e951b2f6000195694dg

Exemplo de resposta

{
  "data": [
    {
      "_id": "5e8f4e855ecb9900194340af",
      "justice": "5e8f3e951b2f6000195694df",
      "filename": "Oficio1.pdf",
      "secretLevel": "Sem Sigilo (Nível 0)",
      "origin": "Automático",
      "file": "33ce8d21dd77470a8e627851d74fca920fc2ac2436ee36b18a092e978b240e8f6f29ff1d4bc8669cfd956c5212b5feaf6c868e5e3c7e55169e4690963f81",
      "fileSize": 29696,
      "hashCode": "5199af979f3c2c506c0a5867030c6aea",
      "type": {
        "description": "Ofício"
      }
    },
    {
      "_id": "5e8f4e855ecb9900194340a0",
      "justice": "5e8f3e951b2f6000195694df",
      "filename": "Inicial.pdf",
      "secretLevel": "Sem Sigilo (Nível 0)",
      "origin": "Automático",
      "file": "33ce8d21dd77470a8e627851d74fca920fc2ac2436ee32bd890e79c08c2a0edd6a24f61d4b9a359cfd956b5149b5f8a86983800c387f52449a4990963f81",
      "fileSize": 593537,
      "hashCode": "06777cf4603e4e01111d51adc41634d2",
      "type": {
        "description": "Inicial Junior 1"
      }
    },
    {
      "_id": "5e8f4e855ecb9900194340c9",
      "justice": "5e8f3e951b2f6000195694df",
      "filename": "Procuracao.pdf",
      "secretLevel": "Sem Sigilo (Nível 0)",
      "origin": "Automático",
      "file": "33ce8d21dd77470a8e627851d74fca920fc2ac2436ee36b18d0c2dc18f220edc6025a71d4bca65ccfd95395612b5f8a865d4d252392f5012c44c90963f81",
      "fileSize": 266880,
      "hashCode": "657df01284e80f1172ec4835e73adbd1",
      "type": {
        "description": "Procuracao"
      }
    }
  ]
}

Download

Para realizar o download de um documento (Stream), basta informar o file do documento na URL.

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
file (obrigatório) é o campo file do documento.

Exemplo de requisição

GET
https://api.loylegal.com/v1/{database}/documents/file/{file}

Peticionamento

Todos os métodos relacionados à peticionamentos estão nesta sessão.

Criação

O primeiro passo é criar uma petição intermediária (em rascunho). No retorno deste POST você deverá guardar o id do peticionamento, pois o mesmo é utilizado para o upload dos documentos, consulta de status, coleta de recibo, etc.

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
justice (obrigatório) é o ID do processo retornado na consulta da capa.

Exemplo de requisição

POST
https://api.loylegal.com/v1/{database}/intermediates

Exemplo do corpo da requisição

{
  "intermediate": {
    "justice": "{justice}",
    "situation": "Rascunho",
    "isWorked": false,
    "signed": true,
  }
}

Exemplo de resposta

{
  "intermediates": {
    "_id": "5be081133fc0ae1c3c254a99",
    "justice": "5bb520081ec92b137690b09a",
    "situation": "Rascunho",
    "isWorked": false,
    "signed": true,
    "createdAt": "2018-11-05T17:42:44.275Z",
    "updatedAt": "2018-11-05T17:42:44.275Z"
  }
}

Upload de Documentos

Para realizar o upload de documentos é necessário informar os seguintes parâmetros:

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
filename (obrigatório) é o nome do arquivo.
file (obrigatório) é o base64 do arquivo PDF.
justice (obrigatório) é o ID do processo.
intermediate (obrigatório) é o ID da petição intermediária.

Obs: Não é obrigatório realizar o envio dos documentos via API, pois, o próprio usuário conseguirá subí-los via interface de peticionamento.

Exemplo de requisição

POST
https://api.loylegal.com/v1/{database}/documents/upload

Exemplo do corpo da requisição

{
  "filename": "Peticao.pdf",
  "file": "JVBERi0xLjMKJfUVPRgo.......",
  "justice": "5bca0da154124f046305aa8f",
  "intermediate": "5be590c663e16506e3c2a71a"
}

Exemplo de resposta

{
  "_id": "5be5c7772c675aadd84e7253",
  "filename": "Peticao.pdf",
  "dateTime": "2018-11-09T17:44:23.631Z",
  "secretLevel": "Sem Sigilo (Nível 0)",
  "origin": "Manual",
  "file": "5be5c7772c675aadd84e7251",
  "fileSize": 3125,
  "fileType": "PDF",
  "isWorked": false,
  "justice": "5bca0da154124f046305aa8f",
  "intermediate": "5be590c663e16506e3c2a71a",
  "createdAt": "2018-11-09T17:44:23.662Z"
}

Janela de Peticionamento

Para realizar a abertura da janela do peticionamento, é necessário informar os seguintes parâmetros:

Parâmetro Descrição
pNumber (obrigatório) é o ID do processo
intermediate (obrigatório) é o ID da petição intermediária
token_peticionamento (obrigatório) é o token de peticionamento fornecido pela Loy
callback (opcional) URL em base64 para redirect após o usuário clicar em Protocolar

Obs: Também é possível configurar uma URL de callback na janela do peticionamento, ou seja, se informado o parâmetro callback na URL, quando o usuário clicar em Protocolar, a nossa janela fará o redirecionamento para o seu sistema e neste momento você saberá que o usuário enviou o protocolo para execução.

Exemplo de requisição

GET
https://app.loylegal.com/delivery/?pNumber={justice}&intermediate={intermediate}&token={token_peticionamento}&callback={callback}

Recibo

Para acompanhar o status de um peticionamento, bem como coletar o recibo, é necessário informar apenas o ID da petição intermediária.

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
intermediate (obrigatório) é o ID da petição intermediária

Obs: Se o retorno do campo isWorked for igual à true, significa que o peticionamento ainda está em execução.

Exemplo de requisição

GET
https://api.loylegal.com/v1/{database}/intermediates/{intermediate}

Exemplo de resposta

{
  "_id": "5e6bd74a85a4ff00195f90c6",
  "justice": "5e444b3a87717f0019596d49",
  "situation": "Ativo",
  "isWorked": false,
  "worker": "1200095",
  "job": "1200096",
  "success": "true",
  "message": "Petição Intermediária Processada Com Sucesso.",
  "receipt": "JVBERi0xLjMKJf...(Recibo PDF em Base64)"
}

Cancelamento

Para cancelar um peticionamento enviado para a fila de execução, é necessário informar apenas o ID da petição intermediária.

Parâmetro Descrição
database (obrigatório) é o CPF/CNPJ da base de dados
intermediate (obrigatório) é o ID da petição intermediária

Exemplo de requisição

POST
https://api.loylegal.com/v1/{database}/intermediates/{intermediate}

Resposta de Cancelamento com Sucesso

{
  "success": true,
  "message": "Intermediária cancelada com sucesso!"
}

Resposta de Intermediaria já protocolada

{
  "success": false,
  "message": "Esta intermediária já foi protocolada! Aguarde o recibo!"
}

Resposta de Intermediaria já processada

{
  "success": false,
  "message": "Esta intermediária já foi processada! Aguarde o retorno!"
}

Resposta de Intermediaria em execução

{
  "success": false,
  "message": "Esta intermediária já está em execução!"
}
Documentação da API Loy