General

All contract types can be managed by the Web-API. Each contract type has its own specifics, there are also some common features, operations or terms used. The following sections provide explanations for the common parts.

Different contract states

During the life cycle an insurance contract can have different states. These are the following states:

  • Proposal
    A proposal is an offer for the future policyholder. Since this is an offer there is no warranty coverage active. A proposal has a period of validity of 60 days and expires after this period. In the case the future policyholder accepts the proposal, it can be switched to an active contract.
  • Contract
    Represents an active insurance contract. The selected warranties are covered.
  • Endorsement
    Modifications to an active insurance contract are named endorsements. An endorsement has always an effective date and a type. Sometimes one type of endorsement excludes other types of endorsement at the same effective date.
  • Derogation
    In some situations, an insurance contract must be accepted by the insurance company. This a called a derogation.
    So for instance, if a driver is to young to drive a car with an higher power, the proposal, contract or endorsement must be accepted by the insurance company. A derogation can be accepted or refused by the company.

Calculation

The Web-API provides several methods to calculate the price (premium).

These are the differences between the calculation methods:

  • Simplified quotation
    A simplified quotation needs the absolute minimum of parameters to get a price for a given contract type. It returns a general premium for the given contract type.
    This calculation is open for everyone and doesn’t need an authentication nor an authorization.
  • Detailed quotation
    A detailed quotation calculation needs more specific entry parameters and due to this, it can return a more adapted and detailed premium.
    An active authentication is needed to use this calculation.
  • Premium calculation
    A premium calculation needs the complete set of parameters to return the premium. It represents the highest level of details about the returned premium.
    An active authentication and an authorization is needed to use this calculation.

Lifetime operations

  • Suspend
  • Terminate
  • Reactivate

Pxx

The Pxx product series includes several products which are determined according to the age ranges of the drivers.

For instance, to subscribe a P50 car insurance, at least one driver must be at least 50 and no more than 59 years old.

At the moment, Aedes offers 5 different Pxx products:

Product

PolicyTypeId Minimum age

Maximum age

KW

P30 43 30 34 <= 145
P35 45 35 39 <= 650
P40 42 40 49 <= 650
P50 41 50 59 <= 650
P60 44 60 74 <= 650

 

 

Acceptance criteria

General

Policyholder

Please refer to | Parties (aedessa.be)

Effect date

This value is automatically the smallest effect date of all warranties.

The start date can’t be in the past, it must be at least today + 1 day and can be maximum 15 months in the future.

Yearly due date

The yearly due date can be submitted using the dd/MM format.

Splitting type

This value is required for the creation of a contract.

The splitting type can be either yearly or monthly.

A monthly splitting needs a SEPA document, which can be created and/or provided after the subscription.

For more information: /lookup/policies/splittingtypes

Recipient of the notice

This value is required for the creation of a contract.

This value determines who will be the recipient of the notice.

There are 3 possible values :

  • First notice goes to the broker, after that always to the policyholder.
  • Always to the broker
  • Always to the policyholder.

For more information: /lookup/policies/recipientnoticeofmaturitytypes

Broker reference

Text field that can be used to store an internal ID.

 

Risk object

Car brand

This value is required for the creation of a contract.

Must be a valid brand for a Pxx product. A list of all valid brands can be consulted using the following call:

/policies/carbrands/pxx

Car model

This value is required for the creation of a contract.

Must be a valid model for a specifique Pxx product. A list of all valid models of a brand can consulted be using the following call:

/policies/carmodels/pxx/{carBrandId}

Car power

This value is required for the creation of a contract.

The power of the car must be a number between 10 KW and 650 KW except for the P30 product where the maximal KW is limited to 144.

First registration date

This value is required for the creation of a contract.

Only cars up to 15 years old (14 years and 364 days) are covered.

Plate number

This value is required for the creation of a contract if a chassis number has not yet been specified.

Must be a valid Belgium plate number.

Chassis number

This value is required for the creation of a contract if a plate number has not yet been specified.

Must be a valid chassis number.

Utility véhicule

Determines if it is a utility car or not. This influences the tax rate to be applied.

 

Driver(s) / Conducteur(s) / Bestuurder(s)

Multiple drivers can be indicated. If the policyholder is a physical person, he must be included in this list.

The last name, first name, the complete address, the birth date, the driver license date, the birthplace, and the profession must be provided.

In case that a driver resides in Belgium, the postal code must be a valid Belgium postal code.

For more information: lookup/parties/localities/postcodes

At least one driver must be in the age range of the desired product.

It is possible to add additional drivers with a different age, but these additional drivers cannot be older than 75 (74 & 365 days) and can’t be younger than the minimum age for the desired product.

However, it is also possible to add younger drivers, but these may drive the car only occasionally (less than 3 times per month).

For exemple for a P50 car insurance, every driver must be at least 50.

The difference between the license date and the birthdate must be at least 17 years.

The driver’s license must be valid for at least 5 years.

A list of all valid professions can be consulted using the following call:

/parties/professions

 

Compagnie antecedents

At least on previous insurance compagnie of the last 5 years must be provided.

The compagnie name and the contract number at that time are the required values.

 

Warranties

The Pxx products allow the subscription of the following warranties:

  • Civil liability
  • Omnium
  • ZEN Package
    • Vehicle assistance
    • Legal protection
    • Driver
  • Person assistance
  • Civil liability for a trailer

The civil liability for the car is automatically included and is not optional, so a effect date for this warranty must always be submitted.

Each warranty can have its own effect date, but this date cannot be more than 15 days into the past.

The smallest warranty effect date determines at the creation of the contract the contract effect date.

For the Omnium warranty, additional information can be submitted:

  • The option to cover material damage. This option determines if the Omnium warranty is a full omnium or not.
  • Information regarding the presence of an alarm system in the car.
  • The invoice value of the car. This value determines the ceiling type of the car. There are 3 types of ceiling: normal, raised and lowered. The ceiling determines the value of the car in case of a total loss. A raised ceiling means also a higher fee and vise versa.

If a trailer should be covered as well, the following information need to be submitted:

  • Effect date
  • Trailer brand
    • Free text field
  • Plate number
    • Requires a valid Belgium plate number.
  • Chassis number
    • Requires a valid chassis number.

 

Claims history

The subscription of a contrat is only allowed if the policyholder has:

  • no civil liability claim (in error) in the last 5 years
  • no theft in the last 5 years
  • no total loss in the last 5 years
  • maximum 1 claim with expenditure in material damage higher than 1000€.

P² formula

Normally the subscription of a contrat with a policyholder with 1 or more claims in the last 5 years will be rejected.

But for the P50 & P60 products, there exists a formula that allows the creation of a contract if the policyholder has 1 claim (and no more) in the last 5 years.

The premiums between this “P²” formula and the normal P products are different.

So how to get this premium:

In the input please set “numberOfClaimsAtFault” to 1 and the “policyholderBirthdate” to a value so that the age of the policyholder is between 50 & 59 (for P50) and 60 & 74 (for P60).

PN1

Description of the PN1 product

Detailed quotation

Description of the detailed quotation

Test

Proposal

Description of the proposal

Contract

Description of the contract

Endorsements

Description of endorsements

Premium

Parameters

Description of the parameter calls

NewB Auto

Detailed quotation

Proposal

Premium

PVelo Family

The PVelo Family product is specially made for famillies who which to insure all there bikes except Speedelec bikes.

Simplified quotation

For the simplified quotation it is only necessary to provide de policyholder post code.

The result is a simplified array of different warranty types with their price in this structure.
– The premium amount vat included.
– The risk object type identifier.
– The warranty type identifier.

Detailed quotation

For the detailled quotation you need to provide.

  • A valid broker code.
  • The calculation date, the date when you want make the calculation.
  •  The policyholder code, must be a valide policyholder code.
  • The policyholder post code, must be a valid belgian post code.
  • The different warranties you want to include.
    •  The broker commission rate, must be between -99.99 to +999.999, 0 or null if you are a broker.
    • The company segmentation rate, must be between -99.99 to +999.999
    • The effect date, the date when the warranty must take effect.
    • The warranty type identifier, is the warranty type you want to include, must be a valid one and unique in array.
    • If you include de comprehensive warranty you need the bike assistance and if you include the bike assistance you need the comprehensive both need to be together.

The result is a array of the different warranty types with the details and a sum of all these warranties.

Premium calculation

For the premium calculation you need to provide.

  • The calculation date, the date when you want make the calculation.
  •  The policyholder code, must be a valide policyholder code.
  • The policyholder post code, must be a valid belgian post code.
  • The different warranties you want to include.
    •  The broker commission rate, must be between -99.99 to +999.999, 0 or null if you are a broker.
    • The company segmentation rate, must be between -99.99 to +999.999
    • The effect date, the date when the warranty must take effect.
    • The warranty type identifier, is the warranty type you want to include, must be a valid one and unique in array.
    • If you include de comprehensive warranty you need the bike assistance and if you include the bike assistance you need the comprehensive both need to be together.

The result is a array of the different warranty types with the details and a sum of all these warranties.

Create proposal

To create a proposal you need to provide:

  • Abroker code.
  • The policyholder code.
  • An accounting expiring day in a correct format.
  • Recipient of maturity type identifier, must be valid.
  • A splitting type identifier.
  • The different warranties you want to include.
    •  The broker commission rate, must be between -99.99 to +999.999, 0 or null if you are a broker.
    • The company segmentation rate, must be between -99.99 to +999.999
    • The effect date, the date when the warranty must take effect.
    • The warranty type identifier, is the warranty type you want to include, must be a valid one and unique in array.
    • If you include de comprehensive warranty you need the bike assistance and if you include the bike assistance you need the comprehensive both need to be together.
    • The effect dates must all be in between 12 month.

You can add:

  • A notice.
  • A broker reference.
  • Documents (maximum 8).

The result is the new create proposal.

Update a proposal

You need to provide the same elements as a creation but need to add de contract code in the url to know which contract needs to be updated.

Activate proposal as policy

You just need to activate a proposal by contract code to activate it as a policy.

Endorse a policy

You can endorse a policy.
For this you need to provide the data to change.

The rules are quite similar then a creation.

Lifetime operations

Some other operations are available.

  • Get a proposal or policy by code.
  • Suspend
  • Reactivate
  • Terminate
  • Update without endorsement

PVelo Solo

This bike contract is for one bike with one or more cyclists.

Acceptance criteria

Policyholder 

Please refer to | Parties (aedessa.be)

Pvelo Solo contract

General contract information:

Field Domain of value Mandatory? Explanation
Effective date Date format (yyyy/mm/dd)
Min: Today – 15 days.
Max: Today + 12 month.
YES This value is automatically the smallest effect date of all warranties.
Yearly due date Dd/MM (CHAR(4)) Must be valid (32/12 not valid) YES Can be submitted using the dd/MM format.
Splitting type Yearly; Monthly (1;2) YES
IBAN Number IBAN rules and must be a BE;NL;FR;DE;LU IBAN ONLY IF Splitting type is Monthly. A monthly splitting needs a SEPA document, which can be created and/or provided after the subscription.
Recipient of the notice 01: Always to the Policyholder

02: Always to the broker

03: First notice goes to the broker, after that always to the policyholder.

 

YES
Broker’s reference CHAR(20) NO You can submit whatever you want. It’s your own reference.

 

 

Risk Object & Warranties

You will find in this table, the risk object information needed or not for each warranty

Field Domain of values Explanation Civil liability Omnium + vehicle assistance Legal protection Driver protection
Type of bike 17 : Bike or e-Bike

18 : Route or e-Route

19 : VTT- e-VTT

20 : Other travel forms

21 : Speed Pedelec

Only the 05 are designed for the bike who can go upper than 25 km/h. YES YES YES YES
Brand Database related YES YES YES YES
Model CHAR(150) Any YES YES YES YES
Frame number CHAR(25) Serial number of the bike ONLY IF TypeofBike = 21 NO NO NO
Plate SPxx001 format
CHAR(10)
Must be a valid SpeedPedelec format. Moreover, you can provide us plate only if Type of bike = 21 Plate with other type of bike will be rejected. ONLY IF TypeofBike = 21 NO NO NO
Buying date Min: 3 years in the past

Max: 3 months in the future

Must be in the range only if Omnium warranty selected. NO YES NO NO
Invoice value Min: 1
Max: 20000
Accessories value Min: 0
Max: 20000
Invoice + Acessories must be <= 20.000 NO YES NO NO
Frame composition 01: Aluminium

02: Steel
03: Carbon
04: Other

NO YES NO NO
New bike TRUE; FALSE Is the bike new? NO NO NO NO
GPS Chips TRUE; FALSE Is the bike equipped with a GPS Chips? NO NO NO NO
Competition usage? TRUE; FALSE Is the bike used for any competition (non-pro too) NO NO NO NO
Padlock TRUE; FALSE Is the bike protected by a padlock? NO YES NO NO
 

 

 

 

Cyclist

 

For every contract, we need to have at least one cyclist related to the risk object and 9 max.
There is only one case where we have rules that applied (see below).

Here is the cyclist info you need to provide:

Field Domain of value Mandatory? Explanation
Name Char(50) YES
Surname Char(50) YES
Street Char(35) YES
Street Number Char(5) YES
Box number CHAR(4) NO
ZIP code CHAR(9)(DB)
Min : 1000
Max : 9999
YES Need to be a valid Zip code
City CHAR(30) YES
Country DB Based (ISO 3166) YES
Birthday Date (yyyy/mm/dd)
Max:  No maximumMin : Today – 16 years
Only if the risk object is a Speed Pedelec and RC warranty is enabled
License day Date (yyyy/mm/dd)
+ You need to have at least 16 years between License Day and birthday and License day >= Birthday
Only if the risk object is a Speed Pedelec and RC warranty is enabled.

 

Simplified quotation

For the simplified quotation you need to provide

  • The policyholder post code, must be a valid belgian post code.
  • Some bike data:
    • Is used for competition, true/false
    • Is padlock used, true/false
    • Is chip installed, true/false
    • Purchase date
    • Value

The result is a simplified array of different warranty types with their price in this structure.
– The premium amount vat included.
– The risk object type identifier.
– The warranty type identifier.

Detailled quotation

For the detailled quotation you need to provide.

  • The broker code, is your broker code.
  • The calculation date, is the date when you want make the calculation.
  •  The policyholder code, must be a valide policyholder code.
  • The policyholder post code, must be a valid belgian post code.
  • The different warranties you want to include.
    •  The broker commission rate, must be between -99.99 to +999.999, 0 or null if you are a broker.
    • The company segmentation rate, must be between -99.99 to +999.999
    • The effect date, the date when the warranty must take effect.
    • The warranty type identifier, is the warranty type you want to include, must be a valid one and unique in array.
    • If you include de comprenhensive warranty you need the bike assistance and if you include the bike assistance you need the comprehensive both need to be together.
  • Some bike data:
    • Is used for competition, true/false
    • Is chip installed, true/false
    • Value

The result is a array of the different warranty types with the details and a sum of all these warranties.

Premium calculation

For the premium calculation you need to provide.

  • The contract code, you need to save a contract before.
  • The calculation date, is the date when you want make the calculation.
  • The policyholder code, must be a valide policyholder code.
  • The driver list by coutry and post code.
  • The frame component type identifier.
  • The different warranties you want to include.
    •  The broker commission rate, must be between -99.99 to +999.999, 0 or null if you are a broker.
    • The company segmentation rate, must be between -99.99 to +999.999
    • The effect date, the date when the warranty must take effect.
    • The warranty type identifier, is the warranty type you want to include, must be a valid one and unique in array.
    • If you include de comprenhensive warranty you need the bike assistance and if you include the bike assistance you need the comprehensive both need to be together.
  • Some bike data:
    • Is used for competition, true/false
    • Is chip installed, true/false
    • Value

The result is a array of the different warranty types with the details and a sum of all these warranties.

Create proposal

Update proposal

You need to provide the same elements as a creation but need to add de contract code in the url to know which contract needs to be updated.

Activate proposal as policy

You just need to activate a proposal by contract code to activate it as a policy.

Lifetime operations

Some other operations are available.

  • Get a proposal or policy by code.
  • Suspend
  • Reactivate
  • Terminate
  • Update without endorsement