Innboforsikring

Under arbeid

Denne dokumentasjonen er under utvikling og kan bli oppdatert.

Dokumentasjon av API for innboforsikring-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 det spesifikke innboforsikringstilbudet som er forespurt.

I header vil vi sende med X-RequestId som er unik, og X-ClientId fra finansportalen.

Eksempel på forespørsel

{
    "id": "string",
    "person": {
        "pid": "string",
        "firstName": "string",
        "lastName": "string",
        "addresses": [
            {
                "source": "string",
                "streetName": "string",
                "postalCode": "string",
                "postalLocation": "string"
            }
        ],
        "memberships": [
            {
                "membershipId": "string",
                "membershipName": "string"
            }
        ]
    },
    "offerRequest": [
        {
            "id": "678aufj",
            "type": "innbo",
            "data": {
                "coverage": "standard",
                "addons": ["sykkeldekning", "tilleggsdekning"],
                "currentAccidents": 0,
                "lastAccidentDate": "string",
                "residence": {
                    "type": "string",
                    "constructionYear": 1990,
                    "constructionType": "string",
                    "rented": false,
                    "rentedBTA": 0,
                    "rentedBRA": 0,
                    "roomsBelowGround": false,
                    "intruderAlarm": {
                        "present": false,
                        "approved": false
                    },
                    "fireAlarm": {
                        "present": false,
                        "emergencyResponse": false
                    },
                    "waterAlarm": {
                        "present": false,
                        "emergencyResponse": false,
                        "approvedStopper": false,
                        "automaticStopper": false
                    },
                    "insuredAmount": "string"
                }
            }
        }
    ],
    "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 adressen 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 forespørselen om tilbud på dette produktet. Eksempel: "678aufj"
type	string	Type produkt. Verdi: "innbo"
data	object	Data for tilbudet

Tilbudsdata-objekt

Felt	Type	Beskrivelse
coverage	string	Dekning for innboforsikringen. Verdier: "standard", "utvidet"
addons	array	Tilleggstjenester for forsikringen. Eksempel: ["sykkeldekning", "tilleggsdekning"]
currentAccidents	number	Antall skader/hendelser tidligere. Eksempel: 0
lastAccidentDate	string	Dato for siste skade/hendelse. Eksempel: "2023-05-15"
residence	object	Informasjon om boligen som skal forsikres

Bolig-objekt

Felt	Type	Beskrivelse
type	string	Type bolig. Verdier: "Enebolig", "Vertikaldelt tomannsbolig", "Horisontaldelt tomannsbolig", "Rekkehus", "Leilighet"
constructionYear	number	Byggeår for boligen. Eksempel: 1990
constructionType	string	Konstruksjonstype for boligen. Verdier: "Tre", "Mur", "Betong"
rented	boolean	Om boligen er utleid. Eksempel: false
rentedBTA	number	Utleid areal i BTA (bruttoareal). Eksempel: 0
rentedBRA	number	Utleid areal i BRA (bruksareal). Eksempel: 0
roomsBelowGround	boolean	Om det er beboelsesrom under bakkenivå. Eksempel: false
insuredAmount	string	Forsikringsbeløpet for innbo. Eksempel: "1000000"

Innbruddsalarm-objekt

Felt	Type	Beskrivelse
present	boolean	Om boligen har innbruddsalarm. Eksempel: false
approved	boolean	Om innbruddsalarmen er FG-godkjent. Eksempel: false

Brannalarm-objekt

Felt	Type	Beskrivelse
present	boolean	Om boligen har brannalarm. Eksempel: false
emergencyResponse	boolean	Om brannalarmen er koblet til alarmsentral. Eksempel: false

Vannalarm-objekt

Felt	Type	Beskrivelse
present	boolean	Om boligen har vannalarm. Eksempel: false
emergencyResponse	boolean	Om vannalarmen er koblet til alarmsentral. Eksempel: false
approvedStopper	boolean	Om vannalarmen har godkjent stopper. Eksempel: false
automaticStopper	boolean	Om vannalarmen har automatisk stopper. Eksempel: false

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": "innbo",
            "productName": "string",
            "prices": {
                "price": 0,
                "discount": 0,
                "originalPrice": 0,
                "tfa": 0.0
            },
            "productDetails": {
                "coverage": "string",
                "ipidUrls": [
                    {
                        "description": "string",
                        "url": "string"
                    }
                ],
                "termsUrls": [
                    {
                        "description": "string",
                        "url": "string"
                    }
                ]
            },
            "offer": {
                "insuredAmount": "string",
                "deductible": 0
            }
        }
    ],
    "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: 3600
totalDiscount	number	Total rabatt for alle produkter. Eksempel: 400
totalOriginalPrice	number	Total originalpris for alle produkter før rabatt. Eksempel: 4000
discountDescription	string	Beskrivelse av rabatten som er gitt. Eksempel: "Medlemsrabatt Tekna"

Produkter-array

Felt	Type	Beskrivelse
id	string	Den unike iden for produktet. Eksempel: "I-123456789"
type	string	Type produkt. Verdi: "innbo"
productName	string	Navnet på produktet. Eksempel: "Innboforsikring Utvidet"

Priser-objekt

Felt	Type	Beskrivelse
price	number	Pris for produktet etter rabatt. Eksempel: 3600
discount	number	Rabatt for produktet. Eksempel: 400
originalPrice	number	Originalpris for produktet før rabatt. Eksempel: 4000
tfa	number	TFA-avgift for produktet. Eksempel: 0.0

Produktdetaljer-objekt

Felt	Type	Beskrivelse
coverage	string	Dekning for produktet. Eksempel: "utvidet"
ipidUrls	array	Liste over urler til IPID-dokumenter
termsUrls	array	Liste over urler til vilkår for produktet

IPID/Vilkår URL-objekt

Felt	Type	Beskrivelse
description	string	Beskrivelse av dokumentet. Eksempel: "Produktinformasjon innboforsikring"
url	string	URL til dokumentet. Viktig å nevne at dette må være en direkte nedlastningslenke som ikke endrer seg. Eksempel: "https://example.com/ipid-innbo.pdf"

Tilbud-objekt

Felt	Type	Beskrivelse
insuredAmount	string	Forsikret beløp i tilbudet. Eksempel: "1000000"
deductible	number	Egenandel for produktet. Eksempel: 4000

Tilleggsfelter for respons

Felt	Type	Beskrivelse
purchaseUrl	string	URL for å kjøpe produktene. Eksempel: "https://example.com/purchase/innbo"
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:05Z"

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.