Update the current version of the draft

Request

PUT https://sbx-api.qover.me/{country}/motor/gap/drafts/{draftId}

Path parameters

Parameter name Value Description Additional
country string

The country ISO code case insensitive Country code in ISO 3166-1 alpha-2 The currently countries for which a line of business is available are:

  • BE
Required
draftId string

The Draft unique Id

Required

Request headers

Parameter name Value Description Additional
Qover-Api-Version string

The version of the api. Currently only '1.0' is available.

Required

Request body

The request body takes a complete Update Draft Body resource, containing the following writable properties:

{
    "language": "string",
    "partnerReference": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "policyholder": {
        "address": {
            "city": "string",
            "country": "string",
            "number": "string",
            "street": "string",
            "zip": "string"
        },
        "billingAddress": {
            "city": "string",
            "country": "string",
            "number": "string",
            "street": "string",
            "zip": "string"
        },
        "company": {
            "firstName": "string",
            "lastName": "string",
            "name": "string",
            "title": "string",
            "vat": "string"
        },
        "contact": {
            "email": "string",
            "phone": "string"
        },
        "person": {
            "birthdate": "date",
            "firstName": "string",
            "lastName": "string",
            "title": "string"
        }
    },
    "risk": {
        "cascoFactors": {
            "deductible": {
                "currency": "string",
                "value": "integer"
            },
            "depreciationRate": {
                "denominator": "integer",
                "numerator": "integer"
            },
            "fullProtectionDuration": "integer"
        },
        "drivers": [
            {
                "contact": {
                    "email": "string",
                    "phone": "string"
                },
                "numberOfClaimsLast5Years": "string",
                "person": {
                    "birthdate": "date",
                    "firstName": "string",
                    "lastName": "string",
                    "title": "string"
                }
            }
        ],
        "vehicle": {
            "cascoInsurerCompany": "string",
            "details": {
                "code": "string",
                "codeType": "string",
                "country": "string",
                "vehicleType": "string"
            },
            "firstRegistrationYear": "date",
            "identification": {
                "registration": {
                    "country": "string",
                    "plate": "string"
                },
                "vin": "string",
                "willProvideLater": "boolean"
            },
            "invoice": {
                "isPurchasedInLast6Months": "boolean",
                "purchasedDate": "date",
                "purchasedPriceIncludingVat": {
                    "currency": "string",
                    "value": "integer"
                }
            }
        }
    },
    "terms": {
        "claimLimit": {
            "currency": "string",
            "value": "integer"
        },
        "requestPaperCopy": "boolean",
        "startDate": "date",
        "variant": "string"
    },
    "whiteLabelId": "string"
}

Properties

Name Type Description Additional
language string

The language of the document. ISO 639-1 codes

Possible values are:

  • nl
  • fr
  • en
Optional
partnerReference[] array Optional
partnerReference[].key string

The item key (No unicity is checked)

partnerReference[].value string

The item value

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.billingAddress object

An address

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

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

policyholder.billingAddress.number string Optional
policyholder.billingAddress.street string
policyholder.billingAddress.zip string
policyholder.company object Company Optional
policyholder.company.firstName string Optional
policyholder.company.lastName string Optional
policyholder.company.name string
policyholder.company.title string Optional
policyholder.company.vat string 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

Optional
policyholder.person.firstName string
policyholder.person.lastName string
policyholder.person.title string Optional
risk object GapRisk Optional
risk.cascoFactors object

The parameters used by the insurance to determine casco value.

Optional
risk.cascoFactors.deductible object Optional
risk.cascoFactors.deductible.currency string

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

Possible values are:

  • EUR
risk.cascoFactors.deductible.value integer

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

risk.cascoFactors.depreciationRate object

A decimal number always represented as a fraction A/B.

  • A is the numerator and is an integer.
  • B is the denominator and is an integer wich cannot be 0. When the Denominator is not specified is assumed to be equal to 1. 123.25 could be represented as numerator=12325 and denominator=100
Optional
risk.cascoFactors.depreciationRate.denominator integer
risk.cascoFactors.depreciationRate.numerator integer
risk.cascoFactors.fullProtectionDuration integer

The number of months for which the casco insurance is covering the full amount of the car price.

Optional
risk.drivers[] array Optional
risk.drivers[].contact object Contact Optional
risk.drivers[].contact.email string

email address must be valid

Optional
risk.drivers[].contact.phone string Optional
risk.drivers[].numberOfClaimsLast5Years string

Number of claims.

Possible values are:

  • 0
  • 1
  • 2
  • 3+
Optional
risk.drivers[].person object

A physical person

Optional
risk.drivers[].person.birthdate date

ISO 8601 Calendar dates format YYYY-MM-DD

Optional
risk.drivers[].person.firstName string
risk.drivers[].person.lastName string
risk.drivers[].person.title string Optional
risk.vehicle object

A vehicle

Optional
risk.vehicle.cascoInsurerCompany string

Possible values are:

  • Actel Direct
  • AG Insurance
  • Allianz
  • Argenta
  • AXA Belgium
  • Baloise Belgium
  • Belfius Verzekeringen
  • Corona
  • Ethias
  • Federale
  • FIDEA
  • Generali Belgium
  • KBC Verzekeringen
  • L'Ardenne Prévoyante
  • NN Insurance Belgium
  • Other
  • P&V Verzekeringen
  • Touring verzekeringen
Optional
risk.vehicle.details object

The Euro Tax formated vehicle details. This information is needed in order to compute a aprice-request.

Optional
risk.vehicle.details.code string

Identifier of the vehicle. currently, only the nat code is supported

risk.vehicle.details.codeType string

Type of identifier used to identify the vehicle. Only eurotax nat code is currently supported.

Possible values are:

  • NAT
risk.vehicle.details.country string

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

risk.vehicle.details.vehicleType string

Type (10 regular car, 20 LCV)

Possible values are:

  • 10
  • 20
risk.vehicle.firstRegistrationYear date

Year of the first registration ISO 8601 Calendar dates format YYYY

Optional
risk.vehicle.identification object

One of the possible vehicle identification information. This can be the vehicle registration, the VIN (Vehicle Identification Number) or a consent explicitely accepted by the subscriber that he will provide this number later.

Optional
risk.vehicle.identification.registration object title Optional
risk.vehicle.identification.registration.country string

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

risk.vehicle.identification.registration.plate string

The vehicle plate number

risk.vehicle.identification.vin string Optional
risk.vehicle.identification.willProvideLater boolean Optional
risk.vehicle.invoice object Optional
risk.vehicle.invoice.isPurchasedInLast6Months boolean

Is the car purchased in the last 6 months ? It can be computed from the field purchasedDate when this fields is provided. If set to true we assume the vehicle was bought in the last 6 months before the date the following contract will be concluded. This field is optional if the field purchasedDate is provided.

Optional
risk.vehicle.invoice.purchasedDate date

ISO 8601 Calendar dates format YYYY-MM-DD The date the vehicle was purchased. If this field is provided then 'isPurchasedInLast6Months' will be computed by checking the purchased date happened 6 months before the contract date is agreed.

Optional
risk.vehicle.invoice.purchasedPriceIncludingVat object
risk.vehicle.invoice.purchasedPriceIncludingVat.currency string

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

Possible values are:

  • EUR
risk.vehicle.invoice.purchasedPriceIncludingVat.value integer

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

terms object title Optional
terms.claimLimit object Optional
terms.claimLimit.currency string

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

Possible values are:

  • EUR
terms.claimLimit.value integer

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

terms.requestPaperCopy boolean Optional
terms.startDate date

ISO 8601 Calendar dates format YYYY-MM-DD

Optional
terms.variant string

Possible values are:

  • GAP12
  • GAP24
  • GAP36
  • GAP48
  • GAP60
Optional
whiteLabelId string

The WhiteLabelId uniquely identifies the rules, templates(branding, colors)... that will be used for this draft and the following related objects. When only one White label is available for this product then this field is optional.

Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Ok: Operation Successful

Headers returned

Name Type Description
Last-Modified date-time
401 Unauthorized

Unauthorized: The authentication failed or is missing

403 Forbidden

Forbidden: You do not have the right to perform this operation

404 Not Found

Not Found: The requested ressource cannot be found

500 Internal Server Error

Internal Server error: The request could not processed due to a server error

General Error

Explore this API

country

The country ISO code case insensitive Country code in ISO 3166-1 alpha-2 The currently countries for which a line of business is available are:

  • BE
draftId

The Draft unique Id

body
Request Content-Type
Qover-Api-Version

The version of the api. Currently only '1.0' is available.

Response Content-Type
Try it out!