Pular para o conteúdo principal

Webhook de status do sinistro

A QI Tech envia este webhook ao originador a cada mudança de status de um sinistro do seguro de uma dívida (CCB): quando o sinistro é aberto junto à seguradora, quando entra em análise, quando é aceito ou recusado e quando é liquidado.

WEBHOOK_TYPE
insurance_premium.claim_status_change

A URL que recebe o webhook é a mesma dos demais webhooks do seguro e é configurada uma única vez para a sua integração. Veja Configurando webhooks.

Corpo do webhook​

CampoTipoObrigatórioDescriçãoTamanho
keyuuidSimChave do sinistro. Igual a data.claim_key.36
statusstringSimStatus do sinistro após a mudança. Veja Status do sinistro.—
webhook_typestringSimSempre insurance_premium.claim_status_change.—
event_datetimestringSimData e hora da mudança, em UTC, no formato AAAA-MM-DDTHH:MM:SSZ.20
dataobjectSimO sinistro. Veja a tabela abaixo.—

Atributos de data​

CampoTipoObrigatórioDescriçãoTamanho
claim_keyuuidSimChave do sinistro.36
statusstringSimStatus do sinistro. Veja Status do sinistro.—
insurance_premium_keyuuidSimChave do seguro, a mesma do webhook insurance_premium.status_change.36
credit_operation_keyuuidSimChave da dívida (CCB) à qual o seguro está atrelado.36
coverage_typestringNãoCobertura do seguro acionada, com o mesmo enumerador da lista covers do seguro. Para desemprego involuntário, unemployment.—
external_keystringNãoReferência do sinistro atribuída pela QI Tech.100
paid_amountnumberSimSoma, em reais, dos pagamentos da seguradora registrados no sinistro. 0 até o primeiro pagamento.—
transactionsarraySimOs pagamentos registrados, do mais antigo ao mais recente. Lista vazia até o primeiro pagamento.—
claim_dataobjectNãoO que a seguradora aprovou. Presente a partir do status accepted.—
reasonstringNãoMotivo da mudança, quando houver. Veja Motivo.—

Atributos de claim_data​

CampoTipoObrigatórioDescriçãoTamanho
approved_amountnumberSimValor máximo aprovado pela seguradora, em reais. A soma dos pagamentos nunca o ultrapassa.—
approved_installment_quantityintegerNãoQuantidade de parcelas da dívida cobertas pela aprovação.—

Atributos de cada item de transactions​

CampoTipoObrigatórioDescriçãoTamanho
claim_transaction_keyuuidSimChave do pagamento.36
amountnumberSimValor do pagamento, em reais.—
payment_datestringSimData do pagamento pela seguradora, no formato AAAA-MM-DD.10
external_transaction_keystringNãoReferência do pagamento atribuída pela seguradora.—

Status do sinistro​

Cada linha é um webhook. O sinistro passa pelos status nesta ordem; rejected e settled são finais.

StatusDescrição
openedSinistro aberto junto à seguradora.
awaiting_analysisEm análise pela seguradora.
acceptedAceito pela seguradora, com o valor aprovado em claim_data. A partir daqui o sinistro recebe pagamentos.
rejectedRecusado. Final.
settledLiquidado. Final. O motivo em reason diz se foi pago por inteiro ou encerrado antes.

Motivo​

EnumeradorStatus em que apareceDescrição
ineligiblerejectedO sinistro não é coberto pelas condições do seguro.
fully_paidsettledOs pagamentos atingiram o valor aprovado.
coverage_endedsettledA cobertura terminou antes de atingir o valor aprovado.
credit_operation_endedsettledA dívida (CCB) foi encerrada antes de atingir o valor aprovado.

Exemplo — sinistro aberto​

{
    "key": "fb88557a-e967-4012-b669-5e1bc2154534",
    "status": "opened",
    "webhook_type": "insurance_premium.claim_status_change",
    "event_datetime": "2026-10-19T20:39:33Z",
    "data": {
        "claim_key": "fb88557a-e967-4012-b669-5e1bc2154534",
        "status": "opened",
        "insurance_premium_key": "0d3b8f62-1a4e-4c7b-9f05-6e2d9a7c4b18",
        "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962",
        "coverage_type": "unemployment",
        "external_key": "sinistro-0001",
        "paid_amount": 0.0,
        "transactions": []
    }
}

Exemplo — sinistro aceito​

{
    "key": "fb88557a-e967-4012-b669-5e1bc2154534",
    "status": "accepted",
    "webhook_type": "insurance_premium.claim_status_change",
    "event_datetime": "2026-10-26T13:02:10Z",
    "data": {
        "claim_key": "fb88557a-e967-4012-b669-5e1bc2154534",
        "status": "accepted",
        "insurance_premium_key": "0d3b8f62-1a4e-4c7b-9f05-6e2d9a7c4b18",
        "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962",
        "coverage_type": "unemployment",
        "external_key": "sinistro-0001",
        "claim_data": {
            "approved_amount": 909.54,
            "approved_installment_quantity": 2
        },
        "paid_amount": 0.0,
        "transactions": []
    }
}

Exemplo — sinistro liquidado​

{
    "key": "fb88557a-e967-4012-b669-5e1bc2154534",
    "status": "settled",
    "webhook_type": "insurance_premium.claim_status_change",
    "event_datetime": "2026-11-30T15:21:47Z",
    "data": {
        "claim_key": "fb88557a-e967-4012-b669-5e1bc2154534",
        "status": "settled",
        "insurance_premium_key": "0d3b8f62-1a4e-4c7b-9f05-6e2d9a7c4b18",
        "credit_operation_key": "5ae2c008-44c1-4435-bbfa-094a4b11d962",
        "coverage_type": "unemployment",
        "external_key": "sinistro-0001",
        "claim_data": {
            "approved_amount": 909.54,
            "approved_installment_quantity": 2
        },
        "paid_amount": 909.54,
        "transactions": [
            {
                "claim_transaction_key": "2b3f2c1e-8b7a-4d0e-9a51-0f6c4b1d7e21",
                "amount": 454.77,
                "payment_date": "2026-11-03",
                "external_transaction_key": "pagamento-0001"
            },
            {
                "claim_transaction_key": "7d1e9a40-3c55-4f6b-8e2a-91b0c6a5f3d8",
                "amount": 454.77,
                "payment_date": "2026-11-30",
                "external_transaction_key": "pagamento-0002"
            }
        ],
        "reason": "fully_paid"
    }
}

Erros​

Este webhook não devolve erro ao originador. A sua URL deve responder com um status 2xx; o comportamento de entrega e o reenvio estão em Configurando webhooks.

Próximo passo​