Skip to content

Rotas Removidas

Endpoints descontinuados, mantidos apenas para referência histórica. As rotas core correspondentes foram removidas e estes proxies não estão mais disponíveis (retornam erro). Não integrar.

Operations

Consulta um processo por np e codvalid
deprecated

Request

⚠️ Rota removida. Endpoint descontinuado — a rota core correspondente foi removida no sweep de código morto e este proxy retorna 400 para qualquer requisição. Mantido aqui apenas para referência histórica.

Substituta: GET /hub-api/process/find-by-np (resolve o processo por nP + cidade + UF, sem exigir o codValid).

Este endpoint permitia consultar um processo específico utilizando o número do processo (nP) e o código validador (codValid).

Security
InternalAuth
Bodyapplication/jsonrequired
nPstringrequired

Número do processo

Example:"337-25-pro-alv"
codValidstringrequired

Código validador

Example:"ckusqxyx"
POST
/hub-api/process/get-by-np
curl -i -X POST \
  https://api.producao.aprova.com.br/hub-api/process/get-by-np \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "nP": "337-25-pro-alv",
    "codValid": "ckusqxyx"
  }'

Responses

Processo encontrado com sucesso

Bodyapplication/json
idstring

Identificador único do processo

Example:"507f1f77bcf86cd799439011"
nPstring

Número do processo

Example:"123-25-PRO-EXE"
cod_validstring

Código validador do processo

Example:"abc12xyz"
fromobject

Informações do criador do processo

configMetadataobject

Metadados da configuração do processo

lastVersionobject

Última versão do processo com todos os dados e campos preenchidos

createdAtstring

Data de criação do processo

Example:"15/10/2025 09:30:00"
timelineArray of objects

Linha do tempo com todos os eventos do processo

Example:
[
  {
    "from": { … },
    "class": "user",
    "type": "evento",
    "data": { … },
    "date": "15/10/2025 09:30:00",
    "created_at_iso": "2025-10-15T12:30:00.000Z"
  },
  {
    "from": { … },
    "to": { … },
    "class": "prefeituraEncaminha",
    "type": "evento",
    "data": { … },
    "date": "15/10/2025 09:30:15",
    "created_at_iso": "2025-10-15T12:30:15.000Z"
  },
  {
    "class": "message",
    "type": "evento",
    "data": { … },
    "from": { … },
    "date": "16/10/2025 14:20:00",
    "created_at_iso": "2025-10-16T17:20:00.000Z"
  }
]
Response
{
  "id": "507f1f77bcf86cd799439011",
  "nP": "123-25-PRO-EXE",
  "cod_valid": "abc12xyz",
  "from": {
    "userID": "auth0|123456789abcdef012345678"
  },
  "configMetadata": {
    "title": "Alvará de Construção",
    "id": "507f191e810c19729de860ea"
  },
  "lastVersion": {
    "from": { … },
    "proprietario": [],
    "destinatario": [ … ],
    "refinamento": { … },
    "cpf_cnpj": "123.456.789-00",
    "created_at_iso": "2025-10-15T14:30:00.000Z",
    "created_at": "15/10/2025 11:30:00",
    "hasSensitiveField": true
  },
  "createdAt": "15/10/2025 09:30:00",
  "timeline": [
    { … },
    { … },
    { … }
  ]
}