Methods

  • post - Create Draft
  • put - Put Draft

Resource

{
    "language": "string",
    "policyholder": {
        "address": {
            "city": "string",
            "country": "string",
            "number": "string",
            "street": "string",
            "zip": "string"
        },
        "company": {
            "billingAddress": {
                "city": "string",
                "country": "string",
                "number": "string",
                "street": "string",
                "zip": "string"
            },
            "billingAddressSameAsCompany": "boolean",
            "firstName": "string",
            "lastName": "string",
            "name": "string",
            "status": "string",
            "title": "string",
            "vat": "string"
        },
        "contact": {
            "email": "string",
            "phone": "string"
        },
        "person": {
            "birthdate": "date",
            "firstName": "string",
            "lastName": "string",
            "status": "string",
            "title": "string"
        }
    },
    "risk": {
        "alreadyOccupied": "boolean",
        "insuredProperty": {
            "address": {
                "city": "string",
                "country": "string",
                "number": "string",
                "street": "string",
                "zip": "string"
            },
            "monthlyCharges": {
                "currency": "string",
                "value": "integer"
            },
            "monthlyRent": {
                "currency": "string",
                "value": "integer"
            },
            "secondType": "string",
            "surfaceArea": {
                "unit": "string",
                "value": "integer"
            },
            "type": "string"
        },
        "minimumSixMonthsTenancy": "boolean",
        "noIncidentInSixMonths": "boolean",
        "tenancyAgreementRegistered": "boolean",
        "willCheckRentAndChargesBalance": "boolean",
        "willMakeBackgroundCheck": "boolean",
        "willSignTenancyAgreement": "boolean"
    },
    "terms": {
        "requestPaperCopy": "boolean",
        "startDate": "date",
        "variant": "string"
    }
}

Properties

Name Type Description Additional
language string

The language of the document.

Possible values are:

  • nl-BE
  • fr-BE
  • en-BE
Optional
policyholder object

The policyholder is a physical person or a company in whose name an insurance policy is held. It cannot be both. If the policyholder has a VAT number then it needs to be considered as a company whatever its legal form is.

Optional
policyholder.address object

An address

Optional
policyholder.address.city string
policyholder.address.country string

The country ISO code Country code in ISO 3166-1 alpha-2

policyholder.address.number string Optional
policyholder.address.street string
policyholder.address.zip string
policyholder.company object Company Optional
policyholder.company.billingAddress object

An address

Optional
policyholder.company.billingAddress.city string
policyholder.company.billingAddress.country string

The country ISO code Country code in ISO 3166-1 alpha-2

policyholder.company.billingAddress.number string Optional
policyholder.company.billingAddress.street string
policyholder.company.billingAddress.zip string
policyholder.company.billingAddressSameAsCompany boolean Optional
policyholder.company.firstName string Optional
policyholder.company.lastName string Optional
policyholder.company.name string
policyholder.company.status string

To define if person is owner of the property or a representative of the owner

Possible values are:

  • owner
  • representative
Optional
policyholder.company.title string Optional
policyholder.company.vat string

VAT number in format BE0123456789

Optional
policyholder.contact object Contact Optional
policyholder.contact.email string

email address must be valid

Optional
policyholder.contact.phone string Optional
policyholder.person object

A physical person

Optional
policyholder.person.birthdate date

ISO 8601 Calendar dates format YYYY-MM-DD

policyholder.person.firstName string
policyholder.person.lastName string
policyholder.person.status string

To define if person is owner of the property or a representative of the owner

Possible values are:

  • owner
  • representative
Optional
policyholder.person.title string Optional
risk object Optional
risk.alreadyOccupied boolean

True if the property is occupied by tenant

Optional
risk.insuredProperty object Optional
risk.insuredProperty.address object

An address

Optional
risk.insuredProperty.address.city string
risk.insuredProperty.address.country string

The country ISO code Country code in ISO 3166-1 alpha-2

risk.insuredProperty.address.number string Optional
risk.insuredProperty.address.street string
risk.insuredProperty.address.zip string
risk.insuredProperty.monthlyCharges object Optional
risk.insuredProperty.monthlyCharges.currency string

ISO 4217 currency code. The only currenlty supported currency is EUR.

Possible values are:

  • EUR
risk.insuredProperty.monthlyCharges.value integer

The amount value multiplied by 100. 13.25 will be represented by the integer 1325.

risk.insuredProperty.monthlyRent object Optional
risk.insuredProperty.monthlyRent.currency string

ISO 4217 currency code. The only currenlty supported currency is EUR.

Possible values are:

  • EUR
risk.insuredProperty.monthlyRent.value integer

The amount value multiplied by 100. 13.25 will be represented by the integer 1325.

risk.insuredProperty.secondType string

Second Type of the property

Possible values are:

  • flat
  • house
  • studio
Optional
risk.insuredProperty.surfaceArea object Optional
risk.insuredProperty.surfaceArea.unit string

Unit of the surface area

Possible values are:

  • m2
Optional
risk.insuredProperty.surfaceArea.value integer

Surface area of the insured property in square meters

Optional
risk.insuredProperty.type string

Property type

Possible values are:

  • residential
Optional
risk.minimumSixMonthsTenancy boolean

Mandatory if the property is occupied by a tenant. True if tenant is in place for more than 6 months

Optional
risk.noIncidentInSixMonths boolean

Mandatory if the property is occupied by a tenant. True if tenant is up to date with his payment and no payment incident occured for the last 6 months

Optional
risk.tenancyAgreementRegistered boolean

Mandatory if the property is occupied by a tenant. True if the owner has registered the tenancy agreeement and the rent plus common charges do not exceed 50% of the income of the tenant

Optional
risk.willCheckRentAndChargesBalance boolean

Mandatory if the property is not occupied by a tenant. True if the owner will make sure that total rent plus common charges do not exceed 50% of the income of the tenant

Optional
risk.willMakeBackgroundCheck boolean

Mandatory if the property is not occupied by a tenant. True if the owner will perform sufficient background checks (solvency, credit, identity reference)

Optional
risk.willSignTenancyAgreement boolean

Mandatory if the property is not occupied by a tenant. True if the owner will sign and register a tenancy agreement

Optional
terms object Optional
terms.requestPaperCopy boolean

True if policyholder requested to receive documents on paper instead of by email

Optional
terms.startDate date

ISO 8601 Calendar dates format YYYY-MM-DD. You can defer the Start date up to 30 days ahead from the date of purchase of the Policy.

Optional
terms.variant string

The label that identifies the variant of the product.

Possible values are:

  • BASIC
  • CLASSIC
  • PREMIUM
Optional