Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Consultar garantias por janela de data

Varredura paginada das garantias FGTS dos empréstimos averbados pela instituição numa janela de data.

Endpoint: POST /econsigado/loans/guarantee-inquiries
Scope: econsignado.read
Equivalente na Dataprev: /emprestimos/garantias-emprestimos-trabalhador

Diferente das outras rotas desta seção, não se informa contrato nem CPF: o escopo é a instituição inteira. Serve para reconciliar a situação das garantias, não para consultar um contrato específico — para isso use Consultar empréstimo.

curl --location 'https://secureapi.onz.finance/api/v2/econsigado/loans/guarantee-inquiries' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data '{
"start_datetime": "21082026000000",
"end_datetime": "21082026163000",
"page_number": 1
}'
CampoObrigatórioDescrição
start_datetimeSimInício da janela (ddMMyyyyHHmmss, horário de Brasília)
end_datetimeSimFim da janela (ddMMyyyyHHmmss), não anterior ao início
page_numberNãoPágina, a partir de 1 (default 1)

A janela não pode terminar no futuro

A Dataprev recusa período cujo fim seja posterior ao instante atual. Por isso o exemplo termina em 163000 e não em 235959: use sempre um horário já passado, com alguns minutos de folga.

As duas validações da janela — fim não anterior ao início e fim não no futuro — acontecem na API, com 400, antes de gastar chamada na Dataprev.

Paginação e resultado vazio

Percorra incrementando page_number até a página vir vazia.

Só aparecem aqui empréstimos com garantia FGTS. Se a janela não tiver nenhum, a resposta vem vazia — e isso indica que a consulta funcionou, não que houve erro. Para ver conteúdo, é preciso ter averbado contrato com has_guarantees: true.

Erros relevantes

HTTPSituação
400end_datetime no futuro ou anterior a start_datetime
403Conta sem a liberação de empréstimo consignado
422Período recusado pela Dataprev