Crédito Consignado INSS
Guias de integração para operações de crédito consignado destinadas a beneficiários do INSS. As páginas estão agrupadas por família de endpoint: uma consulta é documentada uma vez e serve as duas jornadas.
Consultas
Endpoints de consulta ao INSS/Dataprev, comuns a todas as jornadas.
- Lista de Benefícios —
POST /social_security/benefits_request, com o Termo de Autorização. Primeiro passo de qualquer operação. - Dados do Benefício —
POST /social_security/balance_request: saldo, margem e situação. Pré-requisito da averbação. - Consulta Offline de Saldo — últimos dados salvos, de forma síncrona, sem consumir consulta na Dataprev.
- Última Resposta da Averbação — recupera sob demanda o último retorno da Dataprev.
- Portabilidade de Origem — dados do contrato portado da instituição credora original.
- Participantes do CTC — instituições participantes da Núclea/CIP.
Crédito Novo e Refinanciamento Puro
- Fluxo Completo — a ordem das chamadas, da consulta ao desembolso.
- Simulação —
POST /debt_simulation. - Emissão —
POST /debtcom a garantiasocial_security. - Formalização — dados complementares da IN 138 e assinatura da CCB.
- Recálculo — ajusta parcelas e taxas de uma operação existente.
- Falha no Desembolso — TED e Pix devolvidos, e a reapresentação de pagamento.
Portabilidade + Refinanciamento
- Fluxo Completo — a ordem das chamadas de uma portabilidade com ou sem Troco.
- Simulação — fixando a taxa ou o valor liberado.
- Digitação da Proposta —
POST /v2/credit_transfer/proposal. - Formalização — documentos e assinatura da proposta.
- Máquinas de Status — status da portabilidade e do refinanciamento (Troco).
- Correção de Dados — com ou sem nova assinatura da CCB.
- Recálculo e Reformalização — corrige o refinanciamento e a carência.
- Recálculo da Portabilidade — reduz o saldo devedor para caber na margem.
- Diminuir o Valor das Parcelas.
- Alterando o Cessionário —
purchaser_document_numberno aceite.
Reservas
- Averbação e Desaverbação — a constituição da garantia na Dataprev, a teimosinha e a desaverbação.
- Fila Prioritária — marca a reserva como
fixed_ratepara priorização no processamento. - Fura-fila — requisição síncrona com balde de fichas.
- Anuência — quando o beneficiário precisa confirmar a operação.
Assinaturas
- Em grupo — agrupa múltiplas operações do mesmo beneficiário em uma única assinatura.
Referência
- Enumeradores — retornos da Dataprev, status e tipos de benefício. Única definição; as outras páginas linkam para cá.
- Mocks (Sandbox) — CPFs e cenários de teste.