Skip to content

Resolve um processo pelo número do processo e cidade

Request

Resolve o ObjectId de um processo protocolado a partir do número do processo (nP) + cidade (nome) + UF. Use quando você tem o nP mas não tem o código validador — com o ObjectId em mãos, chame GET /hub-api/document/json para o conteúdo completo do processo.

A cidade é resolvida por collation (ignora acento e caixa — Florianopolis corresponde a Florianópolis).

No caso raro de cidade duplicada no mesmo UF com match em mais de uma candidata, a resposta traz ambiguous: true e a lista candidates, sem escolher automaticamente.

Substitui o antigo POST /hub-api/process/get-by-np (removido — ver Rotas Removidas), que exigia o codValid.

Security
InternalAuth
Query
nPstringrequired

Número do processo

Example:nP=664-24-FLN-HAB
cidadestringrequired

Nome da cidade (acento e caixa são ignorados via collation)

Example:cidade=Florianópolis
ufstringrequired

UF de 2 letras

Example:uf=SC
GET
/hub-api/process/find-by-np
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/process/find-by-np?nP=664-24-FLN-HAB&cidade=Florian%C3%B3polis&uf=SC' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Processo resolvido (ou candidatas, quando a cidade é ambígua)

Bodyapplication/json
cityobject or null

Cidade resolvida, ou null quando não encontrada

processobject or null

Processo encontrado, ou null quando o nP não existe na cidade. Use o id em GET /hub-api/document/json

ambiguousboolean

Presente e true quando há mais de uma cidade candidata com match

Example:true
candidatesArray of objects

Candidatas quando ambiguous é true (a escolha fica a cargo do consumidor)

Response
{
  "city": {
    "index": 145,
    "cidade": "Florianópolis",
    "estado": "SC"
  },
  "process": {
    "id": "6a574cfaf63564c7c29d1ea0",
    "nP": "664-24-FLN-HAB",
    "codValid": "4wsuqzit"
  }
}