Reiseforsikring

Under arbeid

Denne dokumentasjonen er under utvikling og kan bli oppdatert.

Dokumentasjon av API for reiseforsikring-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 reiseforsikringstilbudet 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": "reise",
            "data": {
                "coverage": "standard",
                "addons": ["avbestilling", "forsinkelse"],
                "insured": "familie",
                "oldestChild": 12,
                "currentAccidents": 0,
                "lastAccidentDate": "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: "reise"
data	object	Data for tilbudet

Tilbudsdata-objekt

Felt	Type	Beskrivelse
coverage	string	Dekning for reiseforsikringen. Verdier: "standard", "utvidet"
addons	array	Tilleggstjenester for forsikringen. Eksempel: ["avbestilling", "forsinkelse"]
insured	string	Hvem som omfattes av reiseforsikringen. Verdier: "enkeltperson", "familie"
oldestChild	number	Alder på eldste barn (hvis familie er valgt). Eksempel: 12
currentAccidents	number	Antall skader/hendelser tidligere. Eksempel: 0
lastAccidentDate	string	Dato for siste skade/hendelse. Eksempel: "2023-05-15"

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": "reise",
            "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": {
                "insured": "string",
                "deductible": 0,
                "daysCovered": 45
            }
        }
    ],
    "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: 2400
totalDiscount	number	Total rabatt for alle produkter. Eksempel: 200
totalOriginalPrice	number	Total originalpris for alle produkter før rabatt. Eksempel: 2600
discountDescription	string	Beskrivelse av rabatten som er gitt. Eksempel: "Medlemsrabatt Tekna"

Produkter-array

Felt	Type	Beskrivelse
id	string	Den unike iden for produktet. Eksempel: "R-123456789"
type	string	Type produkt. Verdi: "reise"
productName	string	Navnet på produktet. Eksempel: "Reiseforsikring Familie"

Priser-objekt

Felt	Type	Beskrivelse
price	number	Pris for produktet etter rabatt. Eksempel: 2400
discount	number	Rabatt for produktet. Eksempel: 200
originalPrice	number	Originalpris for produktet før rabatt. Eksempel: 2600
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 (insurance product information document)
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 reiseforsikring"
url	string	URL til dokumentet. Viktig å nevne at dette må være en direkte nedlastningslenke som ikke endrer seg. Eksempel: "https://example.com/ipid-reise.pdf"

Tilbud-objekt

Felt	Type	Beskrivelse
insured	string	Hvem som er dekket av forsikringen. Eksempel: "familie"
deductible	number	Egenandel for produktet. Eksempel: 2000
daysCovered	number	Antall dager reiseforsikringen dekker per reise. Eksempel: 45

Tilleggsfelter for respons

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