SIAPE-SIGEPE — Introdução

API para originação de CCB consignado para servidores públicos federais (professores em universidades federais, funcionários em órgãos federais — não inclui militares). A reserva de margem é feita via SIGEPE/SIAPE e exige pré-autorização da QI SCD no Portal do Servidor pelo próprio servidor antes de qualquer operação.

Item	Valor
Autoridade pagadora	Governo Federal / SIGEPE-SIAPE
Tipo de garantia (collateral_type)	federal_payroll
Modelo de reserva	Averbação (assíncrona, consentida no Portal do Servidor)
Funcionamento	07:00–00:00, dias úteis, exceto feriados
Modalidades suportadas	Margem Livre (Crédito Novo) e Portabilidade + Refinanciamento
Pré-autorização do servidor	30 dias de validade — Portal do Servidor: Consignações → Empréstimo Consignado → Autorizar Consignatário
Instrumento	CCB (via POST /debt)

Atenção!

Os webhooks da QI Tech não devem ser mapeados de forma restrita. Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.

Reenvio de Webhooks

Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: Reenvio de Webhooks.

Janela operacional

Diferente do Exército (24/7), o SIAPE só processa de segunda a sexta, das 07:00 às 00:00. Requisições de averbação fora dessa janela ficam em fila e são processadas no próximo dia útil. Planeje retries e SLA com isso em mente.

Fluxo End-to-End

Em margem livre o desembolso vai direto pra conta externa do servidor. Em refinanciamento, portabilidade e compra de dívida o desembolso vai pra uma conta interna em nome do tomador (aberta pelo parceiro via POST /account) — daí a QI quita o contrato externo, repassa o troco e faz a conciliação. Ver Conta Interna para Desembolso.

Modalidades

A operação se divide em quatro modalidades, escolhidas no operation_type e collateral_data:

Modalidade	operation_type / reservation_type	Quando usar	Doc
Margem Livre (Crédito Novo)	operation_type: structured_operation / reservation_type: new_credit	Servidor com margem disponível; sem dívida externa nem refin de operação ativa	→ Margem Livre
Refinanciamento	operation_type: refinancing / reservation_type: refinancing + operation_key	Renegociar operação QI ativa (prazo/taxa), eventualmente liberando troco	→ Port + Refin
Portabilidade (com ou sem troco)	operation_type: refinancing / reservation_type: refinancing + original_contract_number	Trazer dívida de outro banco; pode incluir troco	→ Port + Refin
Compra de dívida (port enrustida)	operation_type: debt_purchase + operation_type: refinancing (dupla)	Trazer N dívidas externas; QI emite uma dupla debt_purchase + refinancing por contrato externo, com desembolso em conta interna em nome do tomador	→ Port + Refin

Pré-requisitos

1. Servidor pré-autorizou QI SCD no Portal do Servidor — autorização válida 30 dias. Sem isso, federal_payroll.balance falha com unauthorized_institution. O parceiro deve orientar o servidor a entrar em Consignações → Empréstimo Consignado → Autorizar Consignatário antes de qualquer chamada.
2. Não há upload de termo de autorização — diferente do Exército, a autorização SIAPE é digital no portal (não há authorization_document_key no payload de balance).

Referência por área

• Consulta de Margem — endpoint /federal_payroll/balance + UPAG
• Margem Livre — Simulação + Emissão para new_credit
• Portabilidade + Refinanciamento — Simulação + Emissão para refinancing + payloads de compra de dívida (debt_purchase + refinancing port-enrustido)
• Formalização — 5 modelos: QI Sign, PDF, opt-in, zip, selfie
• Conta Interna para Desembolso — POST /account em nome do tomador + uso em compra de dívida + ações pós-desembolso
• Assinatura em Lote — agrupar várias operações num único envelope QI Sign (POST /document/document_batch)
• Cancelamento, Desaverbação e Reversal — pré + pós-desembolso + reversal automático
• Webhooks — todos os eventos assíncronos + payloads
• Mapa de Status — enumeradores consolidados
• Mocks (Sandbox) — dados de teste e cenários end-to-end