API Documentation > Contract API > KBO

Kwijtschelden bij overlijden

Introduction

When a customer is deceased a request for remittance can be requested to lessen the burden on the their relatives. This kwijtschelden bij overlijden functionality is made available through the Contract API.

Flow

  1. When a customer is deceased KBO can be requested through the Contract API. In cases of migrated contracts not all information might be available at Alfam. In this case it is required to provide some extra information about the contracts.

  2. The request is send to Alfam Midoffice where the information will extended with the contracts information from the Alfam Backoffice (Centrac).

  3. Using a multitide of validations the request is either rejected or accepted.

  4. The results will be send back to the Frontoffice systems where they can be viewed. A notification will be send when the response becomes available.

  5. Given the request has been accepted a notification will automatically be send to Alfam's betalingsverkeer department to process the remittance.

Requesting remittance

In order to request a remittance the Create Kbo operation from ContractApi needs to be used. A bearer token and a subscription key are required to authenticate.

Retrieving the results

In order to retrieve the remittance result the Get Kbo operation from ContractAPI needs to be used. A bearer token and a subscription key are required to authenticate.

Multiple states of the KBO request can be reflected in the response:

  1. The request is still in processing. Reflected by berichtstatus having the value InBehandeling

  2. The request is scheduled to be processed at a later time. Reflected by the berichtstatus having the values InBehandeling and geplandVerwerkingstijdstip having a DateTime value showing when the request is planned to be processed.

  3. The request is finished but the contract is rejected for remittance. Reflected by berichtstatus having the value Verwerkt and the kbostatus for that contract having the value Afgewezen. In this case no further data, except for the afwijsreden will be given for that contract.

  4. The request is finished and the contract is approved for remittance. Reflected by berichtstatus having the value Verwerkt and the kbostatus for that contract having the value Goedgekeurd. In this case further information is given about the details of the contract and the remittance.

Afwijsreden

Below list describes what each afwijsreden value means:

Value 1 - There was no saldo on the date of decease
Value 2 - Contractant is medecontractant. Only hoofdcontractant is eligible for KBO. Only applicable when the date of decease is before 01-07-2016
Value 3 - There is an arrears on the payments
Value 4 - The carenzperiode is applicable. Carenzperiode is the first six months after a contract has been opened
Value 5 - Age of contractant too high
Value 6 - The date of decease was more than a year ago
Value 8 - Product is not applicable
Value 9 - Other deceased already discharged

Notifications

The KBOResultaatBeschikbaar notification is send when the KBO request process has finished and the results have become available in the Frontoffice.

{
"ReferentieId":"69406600-49e5-4009-9923-e8009f7d91e2",
"GebeurtenisType":"KBOResultaatBeschikbaar",
"Datum":"2021-09-23 10:50:30.050"
}

In the notification body the ReferentieId field represents the KBO objectReferentie. The Datum field represents the date and time on which the event occured and GebeurtenisType represents the type of event that occured.

Availability

The KBO flow is dependent on the availability of Centrac. If Centrac is down at the time a KBO request is performed, the flow will have its start delayed until the moment Centrac is known to be up again. When the start is delayed it will be reflected in the GET KBO response by the value of geplandVerwerkingstijdstip.

Known Centrac downtime periods:

  • On the first or last day of the month Centrac is offline between 00:00 and 06:00, 19:00 and 0:00

  • On Sunday Centrac is offline between 00:00 and 12:00, 17:00 and 18:30, 22:00 and 0:00

  • On any other businessday and Saturday Centrac is offline between 00:00 and 06:00, 20:30 and 0:00