Home Insurance API Quote

---

This method is used to get home insurance quotes based on different quote parameters. Vern will find the most fitting insurance product.

URL

/recommendation/home/quotes

Methods

POST

Data Params

Field	Type	Description	Required
apiKey	string	api key of the sales project. Read more about this argument.	Yes
quoteId	string	External quote id which is going to be associated with the created policy.	No
bundleId	string	ID of the home bundle (predefined for sales partner or find this in the home quote response.	Yes
productId	string	ID of the home product (predefined for sales partner or find this in the home quote response.	Yes
policyHolder	Policyholder	Information of the policyholder.	No
customer	Customer	Information of the customer.	Yes
agreements	array of strings	Links of the accepted agreements.	Yes

PolicyHolder

Field	Type	Description	Required
birthdate	string	Birthdate of the policyholder (YYYY-MM-DD)	Yes

Coverage

Field	Type	Description	Required

Risk

Field	Type	Description	Required

MainBuilding

Field	Type	Description	Required
propertyType	string	type of the property	Yes
ownership	string	type of ownership (either owned or rented)	Yes
area	number	area of the given real estate in m2	Yes
roof	string	type of the roof (either plate,slate,tile,bitumen_plate,other,reeds or wood)	Yes
wall	string	type of the wall (either mixed,lightweight,wood,brick,stone,concrete or other)	Yes
constructionYear	number	the year the real estate was built	Yes
address	object	Address	Yes

Address

Field	Type	Description	Required
country	string	Name of the country	Yes
city	string	Name of the city	Yes
zip	string	Zipcode
route	string	The street name	Yes
streetNumber	string	Street number	Yes

Success Response

Code: 200

Array of Quotes

Field	Type	Description
bundle	Bundle	Offered insurance bundle.
product	Product	Offered insurance product.
price	integer	Full price of the given configuration.
currency	Currency	Currency of the offered priced.
recommended	boolean	If the current configuration is the recommended one amongst all.
groups	array of CoverageGroup	The offered coverage by the product.
agreements	array of Agreement	Agreements to be accepted upon purchasing.
detailUrl	string	Link to the official insurance product description PDF.

Bundle

Field	Type	Description
id	string	ID of the offered insurance bundle.
name	string	Name of the offered bundle.

Product

Field	Type	Description
id	string	ID of the offered insurance product.
name	string	Name of the offered product.
description	string	Description of the offered product.

CoverageGroup

Field	Type	Description
id	string	ID of the coverage group.
name	string	Name of the coverage group.
description	string	Description of the coverage group.
image	string	Link to the icon of the coverage group.
items	Array of CoverageItem	List of coverages.

CoverageItem

Field	Type	Description
id	string	ID of the coverage item.
name	string	Name of the coverage item.
description	string	Description of the coverage item.
value	integer	Covered amount given in the currency below.
currency	Currency	Currency of the covered amount.
important	boolean	If the coverage item is crucial for the selected activity.

Currency

Field	Type	Description
code	string	Currency code, e.g. HUF or EUR.
symbol	string	Symbol to render the currency.
format	string	Rendering format for the currency.

Agreement

Field	Type	Description
id	string	ID of the agreement.
insurerId	string	Owner of the agreement from a legal point of view.
name	string	Name of the agreement.
content	string	Content of the agreement to be accepted.
links	Array of AgreementLink	Links to related documents for the agreement.

AgreementLink

Field	Type	Description
name	string	Name of the link to display.
link	string	Link to the related document.

Sample Call

Body

{
   "publishableKey": "<your publishable key>",
   "country": "HU",
   "bundleId": "5c76e118c7e63415c0e9a500",
   "productId": "5c6ea8efc043d318c6d13668",
   "mainBuilding": {
       "start": "2019-09-01T17:00:00.000Z",
       "end": "2019-09-01T19:00:00.000Z",
       "address": {
         "country: "Hungary",
         "city": "Budapest",
         "zip": "1052",
         "route": "Kossuth Lajos utca",
         "streetNumber": "12",
       },
       "ownership": "owned",
       "area": 101,
       "roof": "slate",
       "wall": "brick",
       "constructionYear": 1911,
       "currency": "HUF"
   }
}

Response

[         
    {
        "bundle": {
            "id": "5c17b9bf32903c0cb48762ce",
            "name": "Home"
        },
        "product": {
            "id": "5bd56f5f4e82779a07a99fc7",
            "name": "Home extra",
            "description": " "
        },
        "price": 12060,
        "currency": {
            "code": "HUF",
            "symbol": "Ft",
            "format": "{value} {symbol}"
        },
        "recommended": true,
        "coverages": [{
            "name": "Jogvédelem",
            "insurerId": "2W972",
            "id": "legal",
        }],
        "risks": [{
            "name": "Tűz",
            "id": "fire",
            "insurerId": "F_ALAP_K",
            "enabled": true,
            "image": "https://cdn.vernsurance.com/f_alap_k.svg"
        }],
        "agreements": [
            {
                "links": [],
                "content": "Az ajánlati adatokat ellenőriztem, és nyilatkozom, hogy azok a valóságnak és az igényeimnek megfelelnek.",
                "name": "Ajánlati adatok",
                "insurerId": "5bb368076f02ad924985a1c6",
                "id": "5c17e17452cbd10e760796fc"
            },
            {
                "links": [
                    {
                        "name": "Insurance product guide",
                        "url": "https://eub.hu/dokumentumok/Termekismerteto-EUB2018-03ONU.pdf"
                    },
                    {
                        "name": "Insurance terms and conditions",
                        "url": "https://eub.hu/dokumentumok/EUB2018-03ONUen.pdf"
                    }
                ],
                "name": "Biztosítási feltételek",
                "insurerId": "5bb368076f02ad924985a1c6",
                "content": "A biztosítási szerződésre vonatkozó biztosítási termékismertetőt , a biztosítási szerződés részét képező biztosítási feltételeket és az ügyféltájékoztatót megismertem és azokat elfogadom.",
                "id": "5c17e26952cbd10e760796fd"
            },
            {
              "links": [],
              "name": "Biztosításközvetítői Feltételek",
              "insurerId": "5bb368076f02ad924985a1c6",
              "content": "Megismertem és elfogadom a biztosítás közvetítő szerződési feltételeit.",
              "id": "5d638e9968dba70472643f8e"
            }
        ],
        "detailUrl": "https://assets.staging.vernhelps.com/terms/eub/EUB2018-03ONU.pdf"
    }
]