API Docs Início Documentação Referência de API Copiar para LLM
CaaS Massificados · Consignado privado

Consignado privado — Consultas e acompanhamento

Dado pessoal ou sensível deve ser mascarado em outputs, logs e exemplos. Todos os valores desta página são fictícios. Formatos de data e de valor: Convenções de dados.

O que é

Depois do envio para aprovação a operação sai das suas mãos e percorre a esteira da UY3. Esta página reúne as consultas que respondem "onde está a operação, o que falta e o que já foi pago".

O acompanhamento do consignado privado é por consulta: você pergunta, a API responde com o status atual. O que cada transição de status significa, e o que fazer em cada uma, está em 4.1 Eventos e notificações.

Quando usar

Pré-requisitos

Endpoints de consulta

Status e dados da operação

GET /v1/CreditNote/{id}
GET /v1/CreditNote

GET /v1/CreditNote/{id} devolve a operação completa: status, cálculo, garantia, documentos, assinaturas e cronograma. É a consulta que responde "e agora?".

GET /v1/CreditNote lista operações com filtros. Os que interessam ao acompanhamento do consignado privado:

Parâmetro Local Obrigatório Como preencher Exemplo
status query Não Status a filtrar. Combine com paginação para varrer a fila de uma etapa. Warranty
personId query Não Todas as operações de um tomador. 11111111-1111-1111-1111-111111111111
productId query Não Todas as operações de um produto contratado. 33333333-3333-3333-3333-333333333333
creditNoteNo query Não Número da operação, quando você tem o número e não o id. 2026/000123
initialDate / finalDate data civil (query) Não Janela de criação. Use para varredura incremental. 2026-08-01 / 2026-08-31
initialPaymentDate / finalPaymentDate data civil (query) Não Janela de vencimento de parcela. 2026-10-01 / 2026-10-31
minValue / maxValue inteiro em centavos (query) Não Faixa de valor contratado. 100000 / 2000000
isDeleted query Não true para incluir operações excluídas logicamente. false
page / size query Não Paginação. Mantenha size moderado em varredura. 1 / 50
orderBy query Não Campo de ordenação. createDate desc 
curl --location --request GET '{{baseUrl}}/v1/CreditNote/55555555-5555-5555-5555-555555555555' \
  --header 'Authorization: Bearer {{token}}' \
  --header 'Accept: application/json'

Assinatura

GET /v1/CreditNote/{id}/SignUrl

Devolve as URLs de coleta de assinatura, para entregar ao tomador. Disponíveis a partir do status Signatures. O andamento da coleta é lido no próprio GET /v1/CreditNote/{id}.

Liquidação e comprovante

GET /v1/CreditNote/{id}/transferReceipt

Devolve o comprovante da transferência (Pix ou TED) feita ao tomador. Disponível a partir da liquidação.

Cronograma de parcelas e quitação

POST /v1/CreditNote/{id}/DuePaymentSchedule
GET  /v1/CreditNote/{id}/LiquidationScheduleCreditNote

DuePaymentSchedule calcula o calendário de quitação da operação — o que o tomador deve para liquidar antecipadamente em uma data.

Consultas dos cadastros

GET /v1/DataprevEmployee/AuthorizationMargin
GET /v1/DataprevEmployee/FreeMarginQuery
GET /v1/NaturalPerson/{id}

A listagem de autorizações confirma se o consentimento do trabalhador está Approved — é a consulta a fazer antes de cada consulta de margem, e não uma vez só por trabalhador. Ver 2.1 Autorização de margem.

O histórico de consultas de margem mostra as margens já apuradas, sem gerar consulta nova.

Extração em lote

GET /v1/CreditNote/Export/excel
GET /v1/CreditNote/related-operations

Export/excel exporta a carteira filtrada em planilha — use para conciliação periódica, não para acompanhamento de operação individual.

Depois do encerramento

POST /v1/DataprevEmployee/SendOperationFundOutstandingBalance
POST /v1/DataprevEmployee/SendRetroactiveOutstandingBalance

Envio do saldo devedor de operações encerradas ao Crédito do Trabalhador, uma operação por vez. Exige permissão de edição de operação e valida que a operação pertence ao ambiente autenticado e está encerrada. Valores em inteiro em centavos. SendRetroactiveOutstandingBalance dispara o envio retroativo de um lote e tem parâmetro limit de query — é feito em janela de baixo movimento por causa do limite de chamadas compartilhado com o leilão.

Webhooks

O acompanhamento hoje é por consulta. O ciclo de vida completo — quais eventos existem, quando cada um acontece, quais exigem ação sua e o padrão de varredura recomendado — está na página dedicada:

→ 4.1 Eventos e notificações

O que acontece depois

Com a operação em Finished, o ciclo de integração se encerra: as parcelas passam a ser descontadas em folha pelo empregador e amortizam o contrato. O que resta do seu lado é a conciliação periódica e, quando aplicável, o envio de saldo devedor.

Antes desta etapa

Próxima etapa

Downloads