Skip to main content

Modelos de Formalização (SIAPE)

A QI suporta 5 modelos de formalização pra operações SIAPE — mesmo conjunto do Exército.

Modelos disponíveis

ModeloQuando usar
QI Sign automático (default)QI envia link de assinatura ao borrower; nenhuma config extra
PDF assinado externamenteParceiro tem signature provider próprio
Data-signature: opt-inBorrower clica "concordo" em portal do parceiro
Data-signature: zipParceiro envia zip de evidências
Data-signature: selfieBiometria via CaaS

QI Sign Automático

Não requer chamada adicional após /debt. QI envia URL pro borrower. Webhook debt fires com status: signature_finished.

PDF assinado externamente

POST /debt/{DEBT_KEY}/signed
{
"signed_document_key": "<uuid retornado pelo upload do PDF>"
}

Data-signature: opt-in

{
"data_signature": {
"type": "opt_in",
"evidence": { "ip_address": "...", "user_agent": "...", "timestamp": "..." }
}
}

Data-signature: zip

{
"data_signature": {
"type": "zip",
"signed_document_key": "<uuid do zip>"
}
}

Data-signature: selfie

Requer integração CaaS (face match + liveness):

{
"data_signature": {
"type": "selfie",
"signed_document_key": "<image_key do CaaS>"
}
}

Webhook após formalização

debt com status: signature_finished — assinatura aceita pela QI. Em seguida, se reservation_method: issuing, a averbação é disparada agora; se creation, já foi disparada antes e o desembolso entra na fila quando confirmada.

Próximo passo

Após o signature_finished, a operação segue automaticamente: averbação confirmada (se issuing) → desembolso PIX/TED → webhook debt (disbursed).

Para acompanhar via webhooks: Webhooks. Para cancelar a qualquer momento: Cancelamento.