Versjon: 1.0.5

Husforsikring

Under arbeid

Denne dokumentasjonen er under utvikling og kan bli oppdatert.

Dokumentasjon av API for husforsikring-integrasjon med Forbrukerrådets forsikringstjeneste.

Forespørsel fra Forbrukerrådet

Når Forbrukerrådet sender en forespørsel til forsikringsselskapet, vil det være i JSON-format. Denne forespørselen inneholder informasjon om personen som skal forsikres, samt detaljer om boligen som skal forsikres.

Eksempel på forespørsel

{
    "id": "f7a28936-8a58-49a5-a989-76c8a752dbdf",
    "person": {
        "pid": "01019612345",
        "firstName": "Ole",
        "lastName": "Nordmann",
        "addresses": [
            {
                "source": "National Registry",
                "streetName": "Ole Nordmanns Gate 1",
                "postalCode": "0123",
                "postalLocation": "OSLO"
            }
        ],
        "memberships": [
            {
                "membershipId": "MEMB-001",
                "membershipName": "Tekna"
            }
        ]
    },
    "offerRequest": [
        {
            "id": "haus-123456",
            "type": "hus",
            "data": {
                "id": "hus-tjorvagen-12",
                "coverage": "standard",
                "addons": ["vannstopper", "sopp_og_råte", "naturskade"],
                "residence": [
                    {
                        "address": {
                            "source": "National Registry",
                            "streetName": "Tjorvågen 12",
                            "postalCode": "4352",
                            "postalLocation": "KLEPPE"
                        },
                        "bathroom": {
                            "totalBathrooms": "2",
                            "oldestLastRenovated": "2019",
                            "olderThanFiftyYears": false
                        },
                        "basement": {
                            "present": true,
                            "arealLiving": "45",
                            "totalRooms": "2"
                        },
                        "fireAlarm": {
                            "present": true,
                            "fgApproved": true
                        },
                        "water": {
                            "waterAlarm": {
                                "present": true,
                                "fgApproved": true,
                                "automaticResponseAlarm": false
                            },
                            "stopper": {
                                "present": true,
                                "automatic": true,
                                "fgApproved": true
                            },
                            "waterCheckLastFiveYears": true,
                            "checkValve": true,
                            "pipeInPipe": true,
                            "pipesLastRenovated": "2019"
                        },
                        "burglarAlarm": {
                            "present": true,
                            "fgApproved": true
                        },
                        "electric": {
                            "passedInspection": true,
                            "inspectedWithThermography": true,
                            "lastInspected": "2022",
                            "lastRenovated": "2019",
                            "automaticCircuitBreaker": true
                        },
                        "renovation": {
                            "renovated": true,
                            "roofAngle": "38",
                            "roofCondition": true,
                            "oldestRoofSection": "2015",
                            "buildingStandard": "god",
                            "buildingCondition": "meget_god",
                            "needsRehab": false
                        },
                        "damages": {
                            "totalLastThreeYears": "0",
                            "pest": "0",
                            "otherDamages": "0",
                            "deductibleFromDamage": "0",
                            "waterDamage": "0",
                            "buildingMoistureProblem": false
                        },
                        "type": "enebolig",
                        "inhabited": true,
                        "inhabitedByOwner": true,
                        "pant": true,
                        "fullValue": "4500000",
                        "constructionYear": "1995",
                        "listed": false,
                        "buildingMaterial": "tre",
                        "totalUnits": "1",
                        "rentingStatus": false,
                        "partiallyRented": false,
                        "totalRentedUnits": "0",
                        "rentedToFamily": false,
                        "rentedToBusiness": false,
                        "Areal": "180",
                        "usedAreal": "180",
                        "livedSpacedAreal": "135",
                        "notLivedSpacesAreal": "45",
                        "moreThan50PercentEmpty": false,
                        "stoveGuard": true,
                        "totalResidents": "4"
                    }
                ]
            }
        }
    ],
    "requestAt": "2024-10-16T12:06:00Z"
}

Feltbeskrivelser for forespørsel

Rotnivåfelter

Felt	Type	Beskrivelse
`id`	string	Den unike IDen for forespørselen
`requestAt`	string	Når forespørselen ble sendt

Person-objekt

Felt	Type	Beskrivelse
`pid`	string	Personnummeret til den som skal forsikres. Eksempel: `"01019612345"`
`firstName`	string	Fornavnet til den som skal forsikres. Eksempel: `"Ole"`
`lastName`	string	Etternavnet til den som skal forsikres. Eksempel: `"Nordmann"`
`addresses`	array	Informasjon om adressene til den som skal forsikres
`memberships`	array	Informasjon om diverse medlemskap om personen som skal forsikres

Adresse-objekt

Felt	Type	Beskrivelse
`source`	string	Kilde for adressen. Eksempel: `"National Registry"`
`streetName`	string	Gatenavnet til adressen. Eksempel: `"Ole Nordmanns Gate 1"`
`postalCode`	string	Postnummeret til adressen. Eksempel: `"0123"`
`postalLocation`	string	Poststedet til adressen. Eksempel: `"OSLO"`

Medlemskap-objekt

Felt	Type	Beskrivelse
`membershipId`	string	IDen til medlemskapet. Eksempel: `"MEMB-001"`
`membershipName`	string	Navnet til medlemskapet. Eksempel: `"Tekna"`

Tilbudsforespørsel-objekt

Felt	Type	Beskrivelse
`id`	string	Den unike iden for tilbudsforespørselen for dette produktet. Eksempel: `"haus-123456"`
`type`	string	Type produkt. Verdi: `"hus"`
`data`	object	Data for tilbudet

Tilbudsdata-objekt

Felt	Type	Beskrivelse
`id`	string	Unik ID for boligen som skal forsikres. Eksempel: `"hus-tjorvagen-12"`
`coverage`	string	Dekning for forsikringen. Verdier: `"standard"`, `"pluss"`, `"ekstra"`
`addons`	array	Tilleggstjenester for forsikringen. Eksempel: `["vannstopper", "sopp_og_råte", "naturskade"]`
`residence`	array	Informasjon om boligen som skal forsikres

Bolig-objekt

Bolig-objektet inneholder detaljert informasjon om eiendommen som skal forsikres.

Boligens adresse

Felt	Type	Beskrivelse
`address.source`	string	Kilde for adressen. Eksempel: `"National Registry"`
`address.streetName`	string	Gatenavnet. Eksempel: `"Tjorvågen 12"`
`address.postalCode`	string	Postnummer. Eksempel: `"4352"`
`address.postalLocation`	string	Poststed. Eksempel: `"KLEPPE"`

Grunnleggende boliginformasjon

Felt	Type	Beskrivelse
`type`	string	Type bolig. Eksempel: `"enebolig"`
`inhabited`	boolean	Om boligen er bebodd
`inhabitedByOwner`	boolean	Om boligen bebos av eier
`pant`	boolean	Om pant er registrert
`fullValue`	string	Full verdi av boligen i NOK. Eksempel: `"4500000"`
`constructionYear`	string	Byggeår for boligen. Eksempel: `"1995"`
`listed`	boolean	Om boligen er fredet
`buildingMaterial`	string	Byggemateriale. Verdier: `"tre"`, `"mur"`, `"betong"`
`totalUnits`	string	Totalt antall enheter. Eksempel: `"1"`
`totalResidents`	string	Totalt antall beboere. Eksempel: `"4"`
`stoveGuard`	boolean	Informasjon om pipevakt

Arealinformasjon

Felt	Type	Beskrivelse
`Areal`	string	Total areal i kvadratmeter. Eksempel: `"180"`
`usedAreal`	string	Bruksareal i kvadratmeter. Eksempel: `"180"`
`livedSpacedAreal`	string	Bebodd areal i kvadratmeter. Eksempel: `"135"`
`notLivedSpacesAreal`	string	Ubebodd areal i kvadratmeter. Eksempel: `"45"`
`moreThan50PercentEmpty`	boolean	Mer enn 50 % ledig

Utleieinformasjon

Felt	Type	Beskrivelse
`rentingStatus`	boolean	Utleiestatus
`partiallyRented`	boolean	Delvis utleid
`totalRentedUnits`	string	Antall utleide enheter. Eksempel: `"0"`
`rentedToFamily`	boolean	Leiet til familie
`rentedToBusiness`	boolean	Leiet til virksomhet

Baderom-objekt

Felt	Type	Beskrivelse
`totalBathrooms`	string	Totalt antall baderom. Eksempel: `"2"`
`oldestLastRenovated`	string	År for eldste siste renovering. Eksempel: `"2019"`
`olderThanFiftyYears`	boolean	Om boligen er eldre enn femti år

Kjeller-objekt

Felt	Type	Beskrivelse
`present`	boolean	Om kjeller er til stede
`arealLiving`	string	Beboelsesareal i kjellen i kvadratmeter. Eksempel: `"45"`
`totalRooms`	string	Totalt antall rom i kjeller. Eksempel: `"2"`

Brannalarm-objekt

Felt	Type	Beskrivelse
`present`	boolean	Om brannalarm er installert
`fgApproved`	boolean	Om alarmen er FG-godkjent

Vann-objekt

Vann-objektet inneholder informasjon om vannvarslingssystem.

Vannalarm

Felt	Type	Beskrivelse
`waterAlarm.present`	boolean	Om vannalarm er installert
`waterAlarm.fgApproved`	boolean	Om vannalarmen er FG-godkjent
`waterAlarm.automaticResponseAlarm`	boolean	Om alarmen har automatisk responssignal

Vannstopper

Felt	Type	Beskrivelse
`stopper.present`	boolean	Om vannstopper er installert
`stopper.automatic`	boolean	Om stoppeventil er automatisk
`stopper.fgApproved`	boolean	Om stopperen er FG-godkjent

Rør og VVS

Felt	Type	Beskrivelse
`waterCheckLastFiveYears`	boolean	Om det er utført vannkontroll de siste fem årene
`checkValve`	boolean	Om tilbakeslagsventil er til stede
`pipeInPipe`	boolean	Om rør-i-rør-system er til stede
`pipesLastRenovated`	string	Når rør sist ble renovert. Eksempel: `"2019"`

Innbruddsalarm-objekt

Felt	Type	Beskrivelse
`present`	boolean	Om innbruddsalarm er installert
`fgApproved`	boolean	Om alarmen er FG-godkjent

Elektrisk-objekt

Felt	Type	Beskrivelse
`passedInspection`	boolean	Om elektriske anlegg har bestått inspeksjon
`inspectedWithThermography`	boolean	Om anlegget er inspisert med termografi
`lastInspected`	string	Siste inspeksjonstidspunkt. Eksempel: `"2022"`
`lastRenovated`	string	Tidspunkt for siste oppussing. Eksempel: `"2019"`
`automaticCircuitBreaker`	boolean	Om det har automatisk sikringsbryter

Renovering-objekt

Felt	Type	Beskrivelse
`renovated`	boolean	Om boligen er renovert
`roofAngle`	string	Takvinkel i grader. Eksempel: `"38"`
`roofCondition`	boolean	Tilstand på taket
`oldestRoofSection`	string	Eldste takseksjon. Eksempel: `"2015"`
`buildingStandard`	string	Bygningsstandard. Verdier: `"lav"`, `"god"`, `"høy"`
`buildingCondition`	string	Bygningstilstand. Verdier: `"dårlig"`, `"god"`, `"meget_god"`
`needsRehab`	boolean	Om rehabilitering er nødvendig

Skader-objekt

Felt	Type	Beskrivelse
`totalLastThreeYears`	string	Totalt antall skader siste tre år. Eksempel: `"0"`
`pest`	string	Antall skadedyrhendelser. Eksempel: `"0"`
`otherDamages`	string	Antall andre skader. Eksempel: `"0"`
`deductibleFromDamage`	string	Egenandel ved skader. Eksempel: `"0"`
`waterDamage`	string	Vannskader. Eksempel: `"0"`
`buildingMoistureProblem`	boolean	Fuktproblemer i bygningen

Respons fra forsikringsselskap

Dette er en beskrivelse av hvordan responsen fra forsikringsselskapet skal være utformet. Det er lagt til eksempler på hva hvert felt skal inneholde.

Eksempel på respons

{
    "id": "string",
    "company": "string",
    "totalPrice": 0,
    "totalDiscount": 0,
    "totalOriginalPrice": 0,
    "discountDescription": "string",
    "products": [
        {
            "id": "string",
            "type": "hus",
            "productName": "string",
            "prices": {
                "price": 0,
                "discount": 0,
                "originalPrice": 0,
                "tfa": 0.0
            },
            "productDetails": {
                "coverage": "string",
                "ipidUrls": [
                    {
                        "url": "string"
                    }
                ],
                "termsUrls": [
                    {
                        "url": "string"
                    }
                ]
            },
            "offer": {
                "fullValue": "string",
                "deductible": 0,
                "additionalCoverage": ["string"]
            }
        }
    ],
    "purchaseUrl": "string",
    "receivedAt": "string",
    "responseAt": "string"
}

Feltbeskrivelser for respons

Rotnivåfelter

Felt	Type	Beskrivelse
`id`	string	Den unike IDen for forespørselen
`company`	string	Navnet på forsikringsselskapet. Eksempel: `"Forsikringsselskap"`
`totalPrice`	number	Total pris for alle produkter etter rabatt. Eksempel: `5200`
`totalDiscount`	number	Total rabatt for alle produkter. Eksempel: `350`
`totalOriginalPrice`	number	Total originalpris for alle produkter før rabatt. Eksempel: `5550`
`discountDescription`	string	Beskrivelse av rabatten som er gitt. Eksempel: `"Medlemsrabatt og boligrabatt"`

Produkter-array

Felt	Type	Beskrivelse
`id`	string	Den unike IDen for produktet. Eksempel: `"hus-123456"`
`type`	string	Type produkt. Verdi: `"hus"`
`productName`	string	Navnet på produktet. Eksempel: `"Husforsikring Standard"`

Priser-objekt

Felt	Type	Beskrivelse
`price`	number	Pris for produktet etter rabatt. Eksempel: `5200`
`discount`	number	Rabatt for produktet. Eksempel: `350`
`originalPrice`	number	Originalpris før rabatt. Eksempel: `5550`
`tfa`	number	TFA-avgift for produktet. Eksempel: `0.0`

Produktdetaljer-objekt

Felt	Type	Beskrivelse
`coverage`	string	Dekning for produktet. Eksempel: `"standard"`
`ipidUrls`	array	Liste over URLer til IPID-dokumenter
`termsUrls`	array	Liste over URLer til vilkårsdokumenter

IPID/Vilkår URL-objekt

Felt	Type	Beskrivelse
`url`	string	URL til dokumentet. Eksempel: `"https://example.com/ipid-hus.pdf"`

Tilbud-objekt

Felt	Type	Beskrivelse
`fullValue`	string	Full verdi for boligen. Eksempel: `"4500000"`
`deductible`	number	Egenandel for produktet. Eksempel: `8000`
`additionalCoverage`	array	Ekstra dekning inkludert. Eksempel: `["vannstopper", "sopp_og_råte", "naturskade"]`

Tilleggsfelter for respons

Felt	Type	Beskrivelse
`purchaseUrl`	string	URL for å kjøpe produktene. Eksempel: `"https://example.com/purchase/hus"`
`receivedAt`	string	Tidspunkt for når forespørselen ble mottatt. Eksempel: `"2024-10-16 12:06:00"`
`responseAt`	string	Tidspunkt for når responsen ble sendt. Eksempel: `"2024-10-16T12:06:30Z"`

Tillatte verdier

Dekningsnivåer

Verdi	Beskrivelse
`standard`	Standard dekning
`pluss`	Pluss dekning
`ekstra`	Ekstra dekning

Boligtyper

Verdi	Beskrivelse
`enebolig`	Enebolig
`tomannsbolig`	Tomannsbolig
`rekkehus`	Rekkehus
`leilighet`	Leilighet

Byggematerialer

Verdi	Beskrivelse
`tre`	Tre
`mur`	Mur
`betong`	Betong

Bygningsstandard

Verdi	Beskrivelse
`lav`	Lav standard
`god`	God standard
`høy`	Høy standard

Bygningstilstand

Verdi	Beskrivelse
`dårlig`	Dårlig tilstand
`god`	God tilstand
`meget_god`	Meget god tilstand

Tilgjengelige tillegg

Verdi	Beskrivelse
`vannstopper`	Vannstopper-dekning
`sopp_og_råte`	Sopp og råte-dekning
`naturskade`	Naturskade-dekning

Ved feil

Hvis feil, ønsker vi at selskapet svarer med statuskode 400 og følgende body:

{
    "error": {
        "code": "string",
        "message": "string"
    }
}

Se Bilforsikring feilhåndtering for liste over feilkoder.

Forespørsel fra Forbrukerrådet​

Eksempel på forespørsel​

Feltbeskrivelser for forespørsel​

Rotnivåfelter​

Person-objekt​

Adresse-objekt​

Medlemskap-objekt​

Tilbudsforespørsel-objekt​

Tilbudsdata-objekt​

Bolig-objekt​

Boligens adresse​

Grunnleggende boliginformasjon​

Arealinformasjon​

Utleieinformasjon​

Baderom-objekt​

Kjeller-objekt​

Brannalarm-objekt​

Vann-objekt​

Vannalarm​

Vannstopper​

Rør og VVS​

Innbruddsalarm-objekt​

Elektrisk-objekt​

Renovering-objekt​

Skader-objekt​

Respons fra forsikringsselskap​

Eksempel på respons​

Feltbeskrivelser for respons​

Rotnivåfelter​

Produkter-array​

Priser-objekt​

Produktdetaljer-objekt​

IPID/Vilkår URL-objekt​

Tilbud-objekt​

Tilleggsfelter for respons​

Tillatte verdier​

Dekningsnivåer​

Boligtyper​

Byggematerialer​

Bygningsstandard​

Bygningstilstand​

Tilgjengelige tillegg​

Ved feil​

Forespørsel fra Forbrukerrådet

Eksempel på forespørsel

Feltbeskrivelser for forespørsel

Rotnivåfelter

Person-objekt

Adresse-objekt

Medlemskap-objekt

Tilbudsforespørsel-objekt

Tilbudsdata-objekt

Bolig-objekt

Boligens adresse

Grunnleggende boliginformasjon

Arealinformasjon

Utleieinformasjon

Baderom-objekt

Kjeller-objekt

Brannalarm-objekt

Vann-objekt

Vannalarm

Vannstopper

Rør og VVS

Innbruddsalarm-objekt

Elektrisk-objekt

Renovering-objekt

Skader-objekt

Respons fra forsikringsselskap

Eksempel på respons

Feltbeskrivelser for respons

Rotnivåfelter

Produkter-array

Priser-objekt

Produktdetaljer-objekt

IPID/Vilkår URL-objekt

Tilbud-objekt

Tilleggsfelter for respons

Tillatte verdier

Dekningsnivåer

Boligtyper

Byggematerialer

Bygningsstandard

Bygningstilstand

Tilgjengelige tillegg

Ved feil