Pular para o conteúdo principal

Consultar processo administrativo por NUP com opções

POST 
/v1/processos/administrativos/nup/:nup

Mesma consulta por NUP do GET, com opções enviadas em JSON: fonte, incluir_documentos, limite_documentos e limite_movimentacoes. Use quando o cliente preferir body em vez de query string. Se a fonte ultrapassar a janela síncrona, a API responde 202 e a consulta continua no servidor.

Valor para a operação: permite a mesma consulta por NUP com opções no body, útil para clientes que montam a requisição em JSON.

Autenticação e resposta: envie a chave em x-api-key ou Authorization: Bearer. Os exemplos mostram uma resposta típica; campos adicionais podem aparecer conforme o tipo de consulta. meta pode conter creditsCharged, creditsRemaining, requestId e searchLogId. Trate erros pelo status HTTP e por error.code.

SLA e HTTP 202: a API reserva uma janela total de até 30 segundos para responder. Quando uma consulta elegível não termina com segurança nessa janela, o trabalho continua no servidor e a resposta é HTTP 202, sem débito adicional naquele estado pendente. Siga o header Location ou data.statusUrl com a mesma API key; Retry-After, pollAfterSeconds, pollAfterMs e nextPollAt informam quando tentar novamente. Pare o polling quando receber um status diferente de 202. A URL de status reproduz a resposta final sem executar nem cobrar a operação novamente. O fluxo pode retornar uma solicitação pendente; consulte a URL/status retornado quando fornecido.

Requisição​

Responses​

Resposta da operação.