Manual Consignado Privado - Averbação de Novos Empréstimos: Consulta de Reservas
Há duas formas de consultar reservas: por operação específica (external_key), útil para acompanhar uma única contratação e recuperar seus comprovantes de averbação/desaverbação; ou em lote (paginada), útil para monitorar várias operações de uma vez sem precisar conhecer a external_key de cada uma.
Consulta por operação (external_key)
Para consultar os dados da averbação de uma operação específica — e, com ela, os comprovantes de protocolo de averbação ou desaverbação — pode-se utilizar o endpoint:
É possível recuperar os comprovantes de averbação, desaverbação e suspensão através do objeto protocols da resposta deste endpoint. Os possíveis enumeradores para protocol_type estão disponíveis na tabela Tipos de protocolo.
Response
Response Body
{
"data": [
{
"reservation_key": "310754e1-cef2-4b19-ba04-7b1c0b575276",
"document_number": "04142652117",
"registration_number": "SECAIXADEA00000000000000006258",
"employer_name": null,
"admission_date": null,
"employer_document_number": "04311093000126",
"external_key": "1d900fed-5ed2-4149-8702-f8dab595b590",
"contract_number": "179799466",
"inclusion_date": "2025-09-30",
"disbursement_date": "2025-02-06",
"contract_data": {
"iof": 227.64,
"periods": [
{
"amount": 338.22,
"due_date": "2025-04-20"
},
{
"amount": 338.22,
"due_date": "2025-05-20"
},
{
"amount": 338.22,
"due_date": "2025-06-20"
},
{
"amount": 338.22,
"due_date": "2025-07-20"
},
{
"amount": 338.22,
"due_date": "2025-08-20"
}
],
"total_amount": 6680.9,
"annual_cet_rate": 0.7176,
"contract_number": "179799466",
"disbursed_amount": 6090.9,
"monthly_cet_rate": 0.0461,
"disbursement_date": "2025-02-06",
"annual_interest_rate": 0.6163544955,
"disbursement_end_date": "2025-02-06",
"monthly_interest_rate": 0.0408
},
"reservation_type": "rollover",
"reservation_status": "reserved",
"protocols": {
"reservation": {
"receipt_url": "[URL]",
"receipt_data": {
"contract_number": "XXX0123456789",
"protocol_number": "21134056260",
"reservation_competence": "2026-03",
"installment_value": 468.6,
"protocol_type": "reservation",
"number_of_installments": 12,
"operation_datetime": "30/01/2026 20:21:22"
},
"protocol_key": "d32342f-369a-4e12-8634-4dfb494d3038"
},
"documents_inclusion": {
"receipt_data": {
"contract_number": "XXX0123456789",
"operation_datetime": "30/01/2026 20:21:29",
"number_of_installments": 12,
"protocol_number": "21134054053",
"installment_value": 468.6,
"protocol_type": "documents_inclusion"
},
"receipt_url": "[URL]",
"protocol_key": "ae018749-7982-4547-92aa-12455e8bafe7"
}
},
}
],
"pagination": {
"current_page": 1,
"next_page": 2,
"rows_per_page": 1
}
}
Consulta em lote (paginada)
Endpoint novo de consulta paginada de reservas, útil para monitorar em lote o andamento de averbações — sem precisar conhecer previamente a external_key de cada operação.
Diferente da consulta por operação acima, este endpoint não recebe nenhuma external_key — ele lista e filtra reservas em lote, entre todas as operações do solicitante.
A consulta é sempre restrita às reservas do próprio solicitante autenticado — não é necessário (nem possível) informar o requester_key como filtro. Para acompanhar novas contratações, filtre por reservation_type=new_credit.
Query Params
| Campo | Descrição | Tipo | Obrigatório | Valores |
|---|---|---|---|---|
document_number | CPF do trabalhador, para filtrar as reservas de um único tomador | Texto | Não | — |
reservation_type | Filtra pelo método de averbação da reserva | Texto | Não | new_credit, refinancing, portability, transferred |
reservation_status | Filtra pelo status atual da reserva | Texto | Não | Ver Enumeradores |
page_number | Número da página, começando em 1 | Número | Não (padrão 1) | Mínimo 1 |
page_rows | Quantidade de registros por página | Número | Não (padrão 25) | Entre 1 e 100 |
Response sucesso
Response Body
{
"data": [
{
"reservation_key": "<Reservation Key>",
"requester_key": "123e4567-e89b-12d3-a456-426614174000",
"document_number": "12345678901",
"registration_number": "99999999999-A",
"employer_name": "VIPER SERVICOS DO NORDESTE LTDA",
"admission_date": "2025-04-02",
"employer_document_number": "12345678901234",
"external_key": "123e4567-e89b-12d3-a456-426614174000",
"contract_number": "2024001234",
"inclusion_date": "2025-04-02",
"disbursement_date": "2025-04-05",
"expiration_date": null,
"contract_data": {
"amount": 5000.00,
"installments": 12,
"interest_rate": 0.018
},
"reservation_data": {
"installment_value": 500.00,
"margin_value": 450.00
},
"reservation_type": "new_credit",
"reservation_status": "reserved",
"reservation_documents_submission_status": "sent",
"protocols": {},
"next_check_datetime": null,
"next_billing_execution_datetime": null,
"balance_inquiry_data": {},
"periods": [],
"warranty_type": null
}
],
"pagination": {
"current_page": 1,
"next_page": 2,
"rows_per_page": 25
}
}
Cada item de data tem o mesmo formato retornado pelos endpoints de autorização (ver Autorização e Averbação). Já pagination.next_page vem null quando a página atual é a última (ou seja, quando a quantidade de itens retornados em data é menor que page_rows); caso contrário, traz o número da próxima página a ser consultada.
Response falha
Quando nenhuma reserva atende aos filtros informados, o endpoint retorna:
Response Body
{
"title": "Reservation not found",
"code": "PRP000035",
"description": "The reservation was not found",
"translation": "A reserva não foi encontrada"
}