{ "components": { "examples": { "getCollectionData-200-insurance-animal-cat": { "description": "Collection data with a cat insurance", "summary": "Get Data response Cat Insurance", "value": [ { "addons": [ { "addOnId": "addonPrevention", "addOnName": "Prévention" } ], "coverage": { "documents": [], "isVersionRequested": false, "parameters": [] }, "deductibles": [ { "deductibleAmount": 0, "deductibleId": "deductibleFixed", "deductibleName": "Franchise" }, { "deductibleAmount": 0, "deductibleId": "deductibleYearly", "deductibleName": "Franchise annuelle" } ], "id": "542f086b-976f-4c97-acaa-b2e9744cbdd1", "insurance": { "@market": "fr", "animalBreed": "Chat de gouttière", "animalGender": "UNKNOWN", "animalName": "Moka", "coming": false, "endDate": "2025-10-28", "holder": { "@market": "fr", "city": "Lille", "dateOfBirth": "1987-05-14", "email": "camille.dupont@example.fr", "firstName": "Camille", "lastName": "Dupont", "name": "Camille Dupont", "phoneNumber": "+33651293847", "postalCode": "59800", "streetAddress": "12 Rue des Tanneurs" }, "insuranceCompany": "fr-acheel", "insuranceName": "Assurance Animaux", "insuranceNumber": "2682234", "insuranceSubType": "catInsurance", "insuranceType": "animalInsurance", "premium": { "@market": "fr", "amount": { "amount": 112.76, "currency": "EUR" }, "paymentFrequency": 12, "period": "YEARLY_PREMIUM_PERIOD", "taxation": "INCLUSIVE_TAXATION" }, "startDate": "2025-10-29", "veterinaryCareAmount": { "amount": 1000, "currency": "EUR" }, "veterinaryCareCoverage": 80 } } ] }, "getCollectionData-200-insurance-generic": { "description": "Collection data with a generic insurance", "summary": "Get Data response Generic Insurance", "value": [ { "addons": [], "coverage": { "documents": [], "isVersionRequested": false, "parameters": [] }, "deductibles": [], "id": "283c6000-2fda-41cf-a41c-5ad70727db21", "insurance": { "endDate": "2026-09-07", "holder": { "@market": "fr", "city": "Rennes", "dateOfBirth": "1991-04-12", "email": "julien.moreau@example.fr", "firstName": "Julien", "gender": "MALE", "lastName": "Moreau", "name": "Julien Moreau", "phoneNumber": "+33648153660", "postalCode": "35001", "streetAddress": "12 Rue des Tisserands" }, "insuranceCompany": "fr-gmf", "insuranceName": "Protection Juridique Essentielle", "insuranceNumber": "004025032833 N", "insuranceSubType": "genericInsurance", "insuranceType": "generalInsurance", "premium": { "@market": "fr", "amount": { "amount": 98.15, "currency": "EUR" }, "paymentFrequency": 12, "period": "YEARLY_PREMIUM_PERIOD", "taxation": "INCLUSIVE_TAXATION" }, "renewalDate": "2026-09-08", "startDate": "2025-09-07" } } ] }, "getCollectionData-200-insurance-house-villa": { "description": "Collection data with a villa insurance", "summary": "Get Data response Villa Insurance", "value": { "addons": [], "deductibles": [ { "deductibleAmount": 300, "deductibleId": "deductibleFire", "deductibleName": "Franchise incendie" }, { "deductibleAmount": 300, "deductibleId": "deductibleLiability", "deductibleName": "Franchise responsabilité civile" }, { "deductibleAmount": 300, "deductibleId": "deductibleTheft", "deductibleName": "Franchise vol et vandalisme" } ], "insurance": { "@market": "fr", "additionalAmenities": [], "coming": false, "endDate": "2025-12-31", "externalId": "bf352123-3b50-4ff0-aaed-a6db887d7692", "insuranceCompany": "fr-acheel", "insuranceHolderCity": "Montpellier", "insuranceHolderDateOfBirth": "1982-05-27", "insuranceHolderEmail": "antoine.charrette@example.com", "insuranceHolderName": "Antoine Charrette", "insuranceHolderPhoneNumber": "+31610933945", "insuranceHolderPostalCode": "34000", "insuranceHolderStreetAddress": "79 Avenue des Pr'es", "insuranceName": "MRH Formule Premium", "insuranceNumber": "1251902", "insuranceObjectCity": "Montpellier", "insuranceObjectPostalCode": "34000", "insuranceObjectStreetAddress": "79 Avenue des Pr'es", "insuranceSubType": "villaInsurance", "insuranceType": "houseContentInsurance", "insuredMovablesAmount": 20000, "insuredValuablesAmount": 30, "livingArea": 143, "outbuildingsTotalArea": { "@type": "area-range", "lowerLimit": 1, "upperLimit": 20 }, "ownershipStatus": "OWNER", "paymentMethod": "UNDEFINED", "policyHolder": { "@market": "fr", "name": { "@market": "fr", "firstName": "Antoine", "fullName": "Antoine Charrette", "lastName": "Charrette" } }, "premium": { "amount": { "currencyCode": "EUR", "minorUnitAmount": 32789 }, "frequency": "YEARLY_PREMIUM_FREQUENCY", "taxation": "INCLUSIVE_TAXATION" }, "premiumAmountYearRounded": 327, "premiumFrequency": 12, "residentialStatus": "PRIMARY_RESIDENCE", "startDate": "2024-01-01" }, "parameters": [ { "isAddonPurchased": false, "parameterDeductible": { "deductibleType": "general", "description": "50€,75€,100€,150€,200€,250€,300€,400€,500€", "displayValue": "50 - 500", "originalDisplayValue": "50 - 500", "personalised": false }, "parameterDescription": "Garantie des dommages consécutifs à une action de l'eau, hors inondation comme la fuite, le débordement, l'infiltration…", "parameterDisplayName": "Dégâts des eaux", "parameterGroup": "Votre habitation", "parameterGroupOrder": 1, "parameterLimit": { "description": "5 fois l’indice pour les objets mobiliers en dépendances", "displayValue": "Conditions Particulières" }, "parameterName": "water", "parameterOrder": 1, "value": "true" }, { "isAddonPurchased": false, "parameterDeductible": { "deductibleType": "general", "description": "50€,75€,100€,150€,200€,250€,300€,400€,500€", "displayValue": "50 - 500", "originalDisplayValue": "50 - 500", "personalised": false }, "parameterDescription": "Indemnisation de votre logement et de vos biens en cas de dommages causés par le feu (inclus dommages induits par les secours).", "parameterDisplayName": "Incendie et événements assimilés", "parameterGroup": "Votre habitation", "parameterGroupOrder": 1, "parameterLimit": { "description": "Bien immobilier : valeur à neuf ", "displayValue": "Conditions Particulières" }, "parameterName": "fire", "parameterOrder": 2, "value": "true" } ], "termsUrl": "/coverage/terms?filePath=fr/condoInsurance/fr-acheel/term_mrh formule premium principale_CG_MRH_ACHEEL_1_C2.pdf" } }, "getCollectionData-200-insurance-person-accident": { "description": "Collection data with an accident insurance", "summary": "Get Data response Accident Insurance", "value": [ { "addons": [], "coverage": { "documents": [], "isVersionRequested": false, "parameters": [] }, "deductibles": [], "id": "dd0d5578-9825-420a-9a9f-e816e9d7f3ab", "insurance": { "@market": "fr", "endDate": "2026-02-17", "holder": { "@market": "fr", "city": "Rennes", "dateOfBirth": "1990-03-12", "email": "julien.moreau@example.fr", "firstName": "Julien", "gender": "MALE", "lastName": "Moreau", "name": "Julien Moreau", "phoneNumber": "+33648224490", "postalCode": "35000", "streetAddress": "18 Rue des Tisserands" }, "insuranceCompany": "fr-gmf", "insuranceName": "Accidents et Famille Formule de base", "insuranceNumber": "004117858288 P", "insuranceSubType": "accidentInsurance", "insuranceType": "personInsurance", "premium": { "@market": "fr", "amount": { "amount": 62.97, "currency": "EUR" }, "paymentFrequency": 12, "period": "YEARLY_PREMIUM_PERIOD", "taxation": "INCLUSIVE_TAXATION" }, "renewalDate": "2026-02-18", "startDate": "2025-08-07" } } ] }, "getCollectionData-200-insurance-person-health": { "description": "Collection data with a health insurance", "summary": "Get Data response Health Insurance", "value": [ { "addons": [], "coverage": { "documents": [], "isVersionRequested": false, "parameters": [] }, "deductibles": [], "id": "551e0de8-3963-4691-8615-a07ab8865f0d", "insurance": { "coming": false, "endDate": "2026-01-17", "holder": { "@market": "fr", "city": "Lyon", "dateOfBirth": "1978-09-22", "firstName": "Isabelle", "gender": "FEMALE", "lastName": "Lefevre", "name": "Isabelle Lefevre", "postalCode": "69007", "streetAddress": "42 Avenue des Lilas" }, "insuranceCompany": "fr-generali", "insuranceName": "Formule 3 Optique et dentaire", "insuranceNumber": "AU409514", "insuranceSubType": "healthInsurance", "insuranceType": "personInsurance", "insuredPersonName": "Isabelle Lefevre", "premium": { "@market": "fr", "amount": { "amount": 3002.66, "currency": "EUR" }, "paymentFrequency": 12, "period": "YEARLY_PREMIUM_PERIOD", "taxation": "INCLUSIVE_TAXATION" }, "startDate": "2025-01-17" } } ] }, "getCollectionData-200-insurance-vehicle-car": { "description": "Collection data with a car insurance", "summary": "Get Data response Car Insurance", "value": [ { "addons": [ { "addOnId": "addOnFRGMFResponsabiliteCivile", "addOnName": "Responsabilité civile" }, { "addOnId": "addOnFRGMFGarantieDuConducteur", "addOnName": "Garantie du conducteur" } ], "coverage": { "documents": [], "isVersionRequested": false, "parameters": [] }, "deductibles": [ { "deductibleAmount": 340, "deductibleId": "deductibleFire", "deductibleName": "Franchise incendie" }, { "deductibleAmount": 340, "deductibleId": "deductibleAccident", "deductibleName": "Franchise accident" }, { "deductibleAmount": 340, "deductibleId": "deductibleTheft", "deductibleName": "Franchise vol et vandalisme" }, { "deductibleAmount": 60, "deductibleId": "deductibleGlass", "deductibleName": "Franchise bris de glace" } ], "documents": [], "id": "4cc00fa1-a4fb-4048-b8f1-4b5cbea8ec9a", "insurance": { "@market": "fr", "bonusMalus": { "coefficient": 0.57 }, "brand": "PEUGEOT", "coverage": "CASCO", "endDate": "2026-12-02", "holder": { "@market": "fr", "city": "Rennes", "dateOfBirth": "1990-03-12", "email": "julien.moreau@example.fr", "firstName": "Julien", "gender": "MALE", "lastName": "Moreau", "name": "Julien Moreau", "phoneNumber": "+33648223390", "postalCode": "35000", "streetAddress": "18 Rue des Tisserands" }, "insuranceCompany": "fr-gmf", "insuranceName": "Tous risques Confort", "insuranceNumber": "003683272091 W", "insuranceSubType": "carInsurance", "insuranceType": "vehicleInsurance", "model": "308", "premium": { "@market": "fr", "amount": { "amount": 686.77, "currency": "EUR" }, "paymentFrequency": 12, "period": "YEARLY_PREMIUM_PERIOD", "taxation": "INCLUSIVE_TAXATION" }, "primaryDriver": { "@market": "fr", "birthDate": "1990-03-12", "licenseIssuingDate": "2011-06-15", "name": "Julien Moreau" }, "registrationNo": "DQ-123-AQ", "renewalDate": "2026-12-03", "secondaryDrivers": [], "startDate": "2025-08-07", "usedForWork": true } } ] }, "getCollectionData-200-insurance-vehicle-motorcycle": { "description": "Collection data with a motorcycle insurance", "summary": "Get Data response Motorcycle Insurance", "value": [ { "addons": [], "coverage": { "documents": [], "isVersionRequested": false, "parameters": [] }, "deductibles": [], "documents": [], "id": "082dfa6a-d2f0-4392-b88d-34706c69195d", "insurance": { "@market": "core", "endDate": "2026-06-25", "holder": { "@market": "fr", "gender": "MALE", "name": "Nicolas Perrin" }, "insuranceCompany": "fr-credit-mutuel", "insuranceName": "Deux roues", "insuranceNumber": "AB 10047322", "insuranceSubType": "motorcycleInsurance", "insuranceType": "vehicleInsurance", "premium": { "@market": "fr", "amount": { "amount": 350.54, "currency": "EUR" }, "paymentFrequency": 12, "period": "YEARLY_PREMIUM_PERIOD", "taxation": "INCLUSIVE_TAXATION" }, "registrationNo": "DP-963-ZY", "renewalDate": "2026-06-26", "startDate": "2018-06-25" } } ] }, "getCollectionStatus-200-completed": { "description": "Example response for getCollectionStatus", "summary": "Collection Status 200 Completed response", "value": { "company": "fr-axa", "id": "8a0c043c8763c3570fab123450d7e492", "pollingInterval": 1000, "status": "COMPLETED" } }, "getCollectionStatus-200-incorrect-credentials": { "description": "Collection Status 200 incorrect credentials", "summary": "Collection Status 200 incorrect credentials", "value": { "company": "fr-generali", "id": "117a54401a0a1234ac765a85eaee7ea9", "pollingInterval": 1000, "status": "INCORRECT_CREDENTIALS" } }, "getCollectionStatus-200-waiting-2fa": { "description": "Collection Status 200 Waiting for two factor authentication", "summary": "Collection Status 200 Waiting for two factor authentication", "value": { "company": "fr-abeille", "extraInformation": { "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": { "authenticationInstruction": "Please check your phone for your code", "responseType": "NUMBER_CODE" } }, "id": "282ebe51cf6f4b8d9b8bbb94c14878db", "pollingInterval": 1000, "status": "TWO_FACTOR_PENDING" } }, "getCompaniesStatus-200-company-email": { "description": "Shows a beta company with USERNAME_PASSWORD Login Method that is currently unavailable", "summary": "Company with USERNAME_PASSWORD Login", "value": [ { "additionalLoginInputs": [], "availableCoverageScopes": [ { "insuranceSubType": "condoInsurance", "insuranceType": "houseContentInsurance" }, { "insuranceSubType": "landlordInsurance", "insuranceType": "houseContentInsurance" }, { "insuranceSubType": "carInsurance", "insuranceType": "vehicleInsurance" } ], "company": "fr-abeille", "companyAndLineOfBusinesses": [ "FR_ABEILLE_HOME", "FR_ABEILLE_VEHICLE" ], "companyDisplayName": "Abeille", "consentRequirements": [ { "method": "NONE", "type": "TRADE_UNION_MEMBERSHIP" } ], "functional": false, "loginMethods": [ "USERNAME_AND_PASSWORD", "PDF_UPLOAD" ], "nonFunctionalLoginMethods": [], "resetCredentials": { "resetPasswordUrl": "https://www.abeille-assurances.fr/particulier/faq-espace-client/recuperer-identifiant-mot-de-passe.html" }, "status": "BETA", "supportsPreheating": false } ] }, "getCompaniesStatus-200-company-functional": { "description": "Shows a single company with typical availability information", "summary": "Company functional", "value": [ { "additionalLoginInputs": [], "availableCoverageScopes": [ { "insuranceSubType": "carInsurance", "insuranceType": "vehicleInsurance" }, { "insuranceSubType": "landlordInsurance", "insuranceType": "houseContentInsurance" }, { "insuranceSubType": "condoInsurance", "insuranceType": "houseContentInsurance" } ], "company": "fr-mma", "companyAndLineOfBusinesses": [ "FR_MMA_VEHICLE", "FR_MMA_HOME" ], "companyDisplayName": "MMA", "consentRequirements": [ { "method": "NONE", "type": "TRADE_UNION_MEMBERSHIP" } ], "functional": true, "loginConfig": { "passwordFieldPlaceholder": "PASSWORD", "passwordLabel": "PASSWORD", "usernameFieldPlaceholder": "EMAIL_MOBILE_CONTRACT", "usernameLabel": "USERNAME" }, "loginMethods": [ "USERNAME_AND_PASSWORD", "PDF_UPLOAD" ], "nonFunctionalLoginMethods": [], "resetCredentials": { "resetPasswordUrl": "https://espace-client.mma.fr/connaissance-client/synthese" }, "status": "OK", "supportsPreheating": false } ] }, "getCompaniesStatus-200-company-login-mobile": { "description": "Shows a single company with a username password login, where the username can be a mobile phone", "summary": "Company login with mobile", "value": [ { "additionalLoginInputs": [], "availableCoverageScopes": [ { "insuranceSubType": "carInsurance", "insuranceType": "vehicleInsurance" }, { "insuranceSubType": "landlordInsurance", "insuranceType": "houseContentInsurance" }, { "insuranceSubType": "condoInsurance", "insuranceType": "houseContentInsurance" } ], "company": "fr-lolivier", "companyAndLineOfBusinesses": [ "FR_LOLIVIER_VEHICLE", "FR_LOLIVIER_HOME" ], "companyDisplayName": "L'Olivier Assurance", "consentRequirements": [ { "method": "NONE", "type": "TRADE_UNION_MEMBERSHIP" } ], "functional": true, "loginConfig": { "passwordFieldPlaceholder": "PASSWORD", "passwordLabel": "PASSWORD", "usernameFieldPlaceholder": "EMAIL", "usernameLabel": "EMAIL" }, "loginMethods": [ "USERNAME_AND_PASSWORD", "PDF_UPLOAD" ], "nonFunctionalLoginMethods": [], "resetCredentials": { "resetPasswordUrl": "https://www.lolivier.fr/espace-perso/#/mot-de-passe-oublie" }, "status": "OK", "supportsPreheating": false } ] }, "getCompaniesStatus-200-company-login-region": { "description": "Shows a single company with a select-one region input field", "summary": "Company with an additional input", "value": [ { "additionalLoginInputs": [ { "key": "region", "options": [ { "label": "GRAND OUEST", "value": "GRAND OUEST" }, { "label": "BOURGOGNE FRANCHE-COMTÉ", "value": "BOURGOGNE FRANCHE-COMTÉ" }, { "label": "NORD", "value": "NORD" }, { "label": "OCCITANE", "value": "OCCITANE" }, { "label": "MEDITERRANEE", "value": "MEDITERRANEE" }, { "label": "AUVERGNE RHONE ALPES", "value": "AUVERGNE RHONE ALPES" }, { "label": "AQUITAINE CENTRE ATLANTIQUE", "value": "AQUITAINE CENTRE ATLANTIQUE" }, { "label": "SUD", "value": "SUD" }, { "label": "ALSACE LORRAINE CHAMPAGNE", "value": "ALSACE LORRAINE CHAMPAGNE" }, { "label": "RIVES DE PARIS", "value": "RIVES DE PARIS" }, { "label": "VAL DE FRANCE", "value": "VAL DE FRANCE" } ], "type": "selectOne" } ], "availableCoverageScopes": [ { "insuranceSubType": "carInsurance", "insuranceType": "vehicleInsurance" }, { "insuranceSubType": "landlordInsurance", "insuranceType": "houseContentInsurance" }, { "insuranceSubType": "condoInsurance", "insuranceType": "houseContentInsurance" } ], "company": "fr-banque-populaire", "companyAndLineOfBusinesses": [ "FR_BANQUE_POPULAIRE_HOME", "FR_BANQUE_POPULAIRE_VEHICLE" ], "companyDisplayName": "Banque Populaire", "consentRequirements": [ { "method": "NONE", "type": "TRADE_UNION_MEMBERSHIP" } ], "functional": true, "loginMethods": [ "PDF_UPLOAD", "MANUAL_SELECT" ], "nonFunctionalLoginMethods": [], "resetCredentials": { "resetPasswordUrl": "" }, "status": "OK", "supportsPreheating": false } ] }, "initiateCollection-201-started": { "description": "Collection started response", "summary": "Collection started response", "value": { "company": "fr-gmf", "extraInformation": null, "id": "117a54401a0a1234ac765a85eaee7ea9", "pollingInterval": 1000, "status": "RUNNING" } }, "initiateCollection-request-username-password": { "description": "A start collection request with username and password", "summary": "CollectionRequest with Username Password", "value": { "company": "fr-gmf", "input": { "PASSWORD": "password123", "USERNAME": "user@example.com" }, "loginMethod": "USERNAME_AND_PASSWORD" } }, "initiateCollection-request-username-password-region": { "description": "A start collection request with username, password and a required region field.", "summary": "CollectionRequest with Username Password and Region", "value": { "company": "fr-banque-populaire", "input": { "PASSWORD": "password123", "REGION": "ALSACE LORRAINE CHAMPAGNE", "USERNAME": "user@example.com" }, "loginMethod": "USERNAME_AND_PASSWORD" } }, "standard-error-400": { "description": "The request body or parameters are invalid.", "summary": "Bad Request", "value": { "errors": [], "localizedMessage": "Invalid request", "message": "Invalid request", "status": "BAD_REQUEST", "statusCode": 400 } }, "standard-error-401": { "description": "The credentials are missing or invalid, the calling IP is not on the client's allowlist, or mTLS is enforced and no valid client certificate was sent. An expired session token gets 401 Token expired.", "summary": "Unauthorized", "value": { "errors": [], "localizedMessage": "Authentication failed", "message": "Authentication failed", "status": "UNAUTHORIZED", "statusCode": 401 } }, "standard-error-403": { "description": "The client is not allowed to use this endpoint or resource.", "summary": "Forbidden", "value": { "errors": [], "localizedMessage": "Not allowed", "message": "Not allowed", "status": "FORBIDDEN", "statusCode": 403 } }, "standard-error-404": { "description": "The requested resource does not exist or has expired.", "summary": "Not Found", "value": { "errors": [], "localizedMessage": "Not found", "message": "Not found", "status": "NOT_FOUND", "statusCode": 404 } }, "standard-error-429": { "description": "The client has sent too many requests in a given time window. Retry after a delay using exponential backoff.", "summary": "Rate limit exceeded", "value": { "errors": [], "localizedMessage": "Too many requests. Please retry with backoff.", "message": "Too many requests. Please retry with backoff.", "status": "TOO_MANY_REQUESTS", "statusCode": 429 } } }, "schemas": { "AddOn": { "description": "An addon for a specific insurance. The addOns can be used for looking up when using the API, while the names might be localized in a way that makes them hard to use. The annualPremium is in the same currency as the insurance. The list relates to reference for possible values of the IDs for different insurance types.", "discriminator": { "propertyName": "insurance-parameters" }, "properties": { "addOnId": { "description": "The technical name of the addon, standardized across different companies.", "example": "addOnLife", "type": "string" }, "addOnName": { "description": "Localized name of the addon, can be used as display name.", "example": "Livförsäkring", "type": "string" }, "addOnPrice": { "description": "The yearly premium paid for the addon.", "example": 576, "format": "int32", "type": "integer" } }, "title": "Insurance Addon" }, "AdditionalBuilding": { "description": "An additional building on the same property as the main residence.", "properties": { "area": { "description": "Area of additional building in square meters rounded to nearest integer. This property will not be available if areaRangeLower and/or areaRangeUpper properties are set.\n", "example": 15, "format": "int32", "type": "integer" }, "areaRangeLower": { "description": "Lower boundary for additional building size in square meters rounded to nearest integer. This property will not be available if the area property is set.\n", "example": 20, "format": "int32", "type": "integer" }, "areaRangeUpper": { "description": "Upper boundary for additional building size in square meters rounded to nearest integer. This property will not be available if the area property is set.\n", "example": 50, "format": "int32", "type": "integer" }, "buildingType": { "description": "The type of the additional building.", "enum": [ "BARN", "BOAT_HOUSE", "GUEST_HOUSE", "CARPORT", "ENCLOSED_PORCH", "GARAGE", "GAZEBO", "GREEN_HOUSE", "POOL", "SAUNA", "SHED", "STABLE", "UNKNOWN" ], "example": "GREEN_HOUSE", "type": "string" }, "floors": { "description": "Number of floors in the additional building.", "example": 2, "format": "int32", "type": "integer" }, "waterConnection": { "description": "Whether the additional building has water connected.", "example": true, "type": "boolean" } }, "title": "AdditionalBuilding" }, "AdditionalLoginInput": { "description": "Additional login input", "example": { "key": "region", "options": [ { "label": "Centre Loire", "value": "centreloire" }, { "label": "Centre Est", "value": "centrest" } ], "type": "selectOne" }, "oneOf": [ { "$ref": "#/components/schemas/SelectOne" } ], "properties": { "type": { "type": "string" } } }, "AdditionalLoginInputSelectOption": { "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ] }, "ApiCoverageDocument": { "properties": { "documentType": { "type": "string" }, "documentUrl": { "type": "string" } } }, "BonusMalus": { "description": "Bonus/Malus on the insurance policy", "properties": { "coefficient": { "description": "Bonus/Malus coefficient", "example": 0.6, "format": "double", "type": "number" } } }, "Claims": { "description": "Details about the insurance claims history", "properties": { "numberOfClaims": { "description": "Total count of insurance claims filed", "example": 3, "format": "int32", "type": "integer" }, "periodInMonths": { "description": "The count of months since the earliest recorded insurance claim", "example": 24, "format": "int32", "type": "integer" } } }, "CollectionInput": { "description": "A `CollectionInput` is a set of values that required for the collection process to continue. The required input is specified by the key `REQUIRED_INPUT_TYPES`, under the `extraInformation` key on the `CollectionStatus` object.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Item" }, "type": "array", "uniqueItems": true }, "type": { "enum": [ "COLLECTION_INPUT" ], "example": "COLLECTION_INPUT", "type": "string" } } }, "CollectionRequest": { "discriminator": { "propertyName": "api" }, "properties": { "company": { "description": "The name of the company to trigger the collection from", "example": "se-lansforsakringar", "type": "string" }, "consents": { "description": "A set of consents provided by the end user.", "items": { "$ref": "#/components/schemas/ConsentRequestInput" }, "type": "array", "uniqueItems": true }, "filter": { "$ref": "#/components/schemas/CollectionRequestFilter" }, "input": { "additionalProperties": { "type": "string" }, "description": "Key-value object specifying additional input required for the collection. What values should be included depends on context.Possible keys are `SWEDISH_PERSONAL_NUMBER`, `NORWEGIAN_PERSONAL_NUMBER`, `NORWEGIAN_PHONE_NUMBER`,`USERNAME`, `PASSWORD`, `LASTNAME`, `ACCOUNT_OWNER_NAME`.", "example": { "SWEDISH_PERSONAL_NUMBER": "192101010101" }, "propertyNames": { "enum": [ "SESSION_ID", "ADVISOR_HANDLE", "EXTERNAL_REFERENCE", "USERNAME", "PASSWORD", "REGION" ], "type": "string" }, "type": "object" }, "loginMethod": { "description": "Login method that will be used to authenticate the user. Available login methods for a company is specified in the `/companies/availability` response.", "enum": [ "USERNAME_AND_PASSWORD", "PDF_UPLOAD", "AUTHENTICATION_APP_URL", "MANUAL_SELECT" ], "example": "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "type": "string" } } }, "CollectionRequestFilter": { "properties": { "rules": { "items": { "$ref": "#/components/schemas/CollectionRequestFilterRule" }, "type": "array", "uniqueItems": true } } }, "CollectionRequestFilterRule": { "properties": { "field": { "enum": [ "registrationNo" ], "type": "string" }, "value": { "type": "string" } } }, "CollectionStatus": { "discriminator": { "propertyName": "api" }, "properties": { "company": { "description": "Company that this collection is from", "example": "se-lansforsakringar", "type": "string" }, "externalUserUuid": { "description": "The UUID of the external user this collection belongs to, when it is linked to one (null otherwise). Can be used to build a Hub deep-link of the form /collections/user/{externalUserUuid}.", "example": "b3f1c2a4-8d6e-4f2b-9a1c-7e5d3b2a1f0e", "type": "string" }, "extraInformation": { "$ref": "#/components/schemas/CollectionStatusInformationMap", "description": "A key-value map containing potential extra information, depending on the company the collection is getting data from.", "example": { "SWEDISH_BANKID_QRCODE": "iVBORw0KGgoAA==", "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": "38bb848d-5a0d-4dec-977d-a8777f3637da" } }, "id": { "description": "The collection ID of the request", "example": "22e633bc-427d-4f4a-87cf-cfaca04ef351", "type": "string" }, "pollingInterval": { "description": "The recommended interval in milliseconds at which to poll the `/status` endpoint for a collection. The endpoint can be polled less often, but latest by the value indicated by `pollingTimeout` to ensure that the collection is not terminated.", "example": 1000, "format": "int32", "type": "integer" }, "pollingTimeout": { "description": "The collection status must be polled before this timestamp. Failure to do so may result in the termination of the collection.", "example": "2024-09-26T12:59:10.545Z", "format": "date-time", "type": "string" }, "status": { "description": "Current status of the collection.", "enum": [ "RUNNING", "LOGIN", "CUSTOMER_ENROLLMENT_CHECK", "TWO_FACTOR_PENDING", "TWO_FACTOR_METHOD_SELECTION_TIMEOUT", "CONTACT_FORM_PENDING", "COLLECTION_INPUT_PENDING", "COLLECTION_INPUT_TIMEOUT", "COLLECTING", "COMPLETED", "COMPLETED_PARTIAL", "COMPLETED_EMPTY", "FAILED", "FAILED_PDF_PARSE", "FAILED_PDF_USER_INPUT", "AUTHENTICATION_TIMEOUT", "WAITING_FOR_USER_ACTION", "INCORRECT_CREDENTIALS", "INCORRECT_TWO_FACTOR_CODE", "AUTHENTICATION_CANCELLED", "AUTHENTICATION_CONFLICT", "ACCOUNT_TEMPORARILY_LOCKED", "AUTHENTICATION_MISMATCH", "KYC_FORM", "CONTACT_FORM", "CUSTOMER_ENROLLMENT_REQUIRED", "THIRD_PARTY_ERROR" ], "example": "RUNNING", "type": "string" } }, "required": [ "company", "id", "status" ], "title": "CollectionStatus" }, "CollectionStatusInformationMap": { "description": "Possible extra information returned for a collection status", "discriminator": { "propertyName": "api" }, "properties": { "ACCESS_TOKEN": { "description": "Access token to call get-data. Returned when data collection is initiated by client-id.", "type": "string" }, "AUTHENTICATION_APP_URL": { "description": "A url to trigger authentication apps.", "example": "https://banklogin.com/challenge?id=bc453568-1e63-432c-9957-ae2fc6acb826", "type": "string", "x-markets": { "at": true, "ee": true, "fr": true, "it": true, "lt": true, "lv": true, "uk": true } }, "AVAILABLE_TWO_FACTOR_METHODS": { "description": "Available 2FA methods for this collection.", "items": { "$ref": "#/components/schemas/TwoFactorOption" }, "type": "array" }, "INSTRUCTIONS": { "$ref": "#/components/schemas/InstructionsRequestObject", "description": "Instructions used for SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION login method.", "x-markets": { "se": true } }, "QR_CODE_DATA": { "description": "A base64 encoded QR-code.", "example": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==", "type": "string" }, "REFERENCE_NUMBER": { "description": "Reference number from login page to verify on other device.", "example": "1234", "type": "string" }, "REQUIRED_INPUT_TYPES": { "description": "Input that needs to be provided for the collection process to continue.", "example": "EMAIL", "items": { "description": "Type of input.", "enum": [ "EMAIL", "LOGIN_METHOD", "PASSWORD", "USERNAME" ], "example": "EMAIL", "type": "string" }, "type": "array" }, "RESEND_CODE_THRESHOLD_SECONDS": { "description": "Number of seconds to wait before showing the resend 2FA code option. Null if resend is not available.", "format": "int32", "type": "integer", "x-markets": { "fr": true } }, "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": { "$ref": "#/components/schemas/TwoFactorAuthenticationInstruction" } }, "title": "CollectionStatusInformation" }, "Company": { "enum": [ "fr-abeille", "fr-acheel", "fr-allianz", "fr-ametis-wealth", "fr-amundi", "fr-animauxsante", "fr-assur-opoil", "fr-axa", "fr-bnp-paribas", "fr-bred-wealth", "fr-bulle-bleue", "fr-cardif", "fr-credit-agricole", "fr-credit-mutuel", "fr-dalma", "fr-demo", "fr-demo-info-retraite", "fr-demo-preheat", "fr-eca", "fr-finary-wealth", "fr-generali", "fr-gmf", "fr-groupama", "fr-hello-bank", "fr-info-retraite", "fr-la-banque-postale", "fr-la-banque-postale-wealth", "fr-lemonade", "fr-luko", "fr-lcl-assurances", "fr-maaf", "fr-macif", "fr-matmut", "fr-maif", "fr-mma", "fr-nortia-wealth", "fr-santevet", "fr-societe-generale", "fr-societe-generale-insurance", "fr-trade-republic", "fr-lolivier", "fr-caisse-depargne", "fr-caisse-depargne-wealth", "fr-banque-populaire", "fr-banque-populaire-wealth", "fr-bred", "fr-direct-assurance", "fr-harmonie-mutuelle", "fr-malakoff-humanis", "fr-alan", "fr-aesio-mutuelle", "fr-ag2r-la-mondiale", "fr-bourso-bank", "fr-bnp-paribas-wealth", "fr-credit-agricole-wealth", "fr-cardif-wealth", "fr-generali-wealth", "fr-generali-wealth-access-clients", "fr-generali-wealth-espace-epargne", "fr-generali-wealth-secure-boutique", "fr-generali-wealth-nomineo", "fr-cnp", "fr-allianz-wealth", "fr-groupama-wealth", "fr-n26", "fr-axa-wealth", "fr-fortuneo", "fr-credit-mutuel-wealth", "fr-ag2r-la-mondiale-wealth", "fr-revolut", "fr-lcl-wealth" ], "type": "string" }, "CompanyAvailability": { "discriminator": { "propertyName": "api" }, "properties": { "additionalLoginInputs": { "description": "Additional input for login step.", "items": { "$ref": "#/components/schemas/AdditionalLoginInput" }, "type": "array", "uniqueItems": true }, "availableCoverageScopes": { "description": "Set of available coverage types and subtypes for this company", "example": [ { "insuranceSubType": "CAR_INSURANCE", "insuranceType": "VEHICLE_INSURANCE" } ], "items": { "$ref": "#/components/schemas/InsuranceTypeAndSubtype" }, "type": "array", "uniqueItems": true }, "company": { "description": "Name of the company.", "example": "uk-aviva", "minLength": 1, "type": "string" }, "companyAndLineOfBusinesses": { "description": "Available company and line of business for insurance pdf upload.", "example": "UK_AXA_HOME", "items": { "enum": [ "FR_ABEILLE_HOME", "FR_ABEILLE_VEHICLE", "FR_ALLIANZ_HOME", "FR_ALLIANZ_VEHICLE", "FR_ANIMAUXSANTE_HOME", "FR_ASSUR_OPOIL_ANIMAL", "FR_AXA_HOME", "FR_AXA_VEHICLE", "FR_AXA_GENERAL", "FR_BANQUE_POPULAIRE_HOME", "FR_BANQUE_POPULAIRE_VEHICLE", "FR_BULLE_BLEUE_HOME", "FR_CAISSE_DEPARGNE_HOME", "FR_CAISSE_DEPARGNE_VEHICLE", "FR_CARDIF_HOME", "FR_CREDIT_AGRICOLE_HOME", "FR_CREDIT_AGRICOLE_VEHICLE", "FR_CREDIT_MUTUEL_HOME", "FR_CREDIT_MUTUEL_VEHICLE", "FR_DEMO_HOME", "FR_DEMO_VEHICLE", "FR_DIRECT_ASSURANCE_HOME", "FR_DIRECT_ASSURANCE_VEHICLE", "FR_ECA_HOME", "FR_ECA_VEHICLE", "FR_ECA_ANIMAL", "FR_GENERALI_HOME", "FR_GENERALI_VEHICLE", "FR_GMF_HOME", "FR_GMF_VEHICLE", "FR_GROUPAMA_HOME", "FR_GROUPAMA_VEHICLE", "FR_LUKO_HOME", "FR_LOLIVIER_HOME", "FR_LOLIVIER_VEHICLE", "FR_LA_BANQUE_POSTALE_HOME", "FR_LA_BANQUE_POSTALE_VEHICLE", "FR_MAAF_HOME", "FR_MAAF_VEHICLE", "FR_MACIF_HOME", "FR_MACIF_VEHICLE", "FR_MAIF_HOME", "FR_MAIF_VEHICLE", "FR_MATMUT_HOME", "FR_MATMUT_VEHICLE", "FR_SOCIETE_GENERAL_INSURANCE_HOME", "FR_SOCIETE_GENERAL_INSURANCE_VEHICLE", "FR_MMA_HOME", "FR_MMA_VEHICLE", "FR_SANTEVET_HOME", "FR_AXA_PERSON", "FR_ACHEEL_HOME", "FR_ACHEEL_VEHICLE", "FR_MALAKOFF_HUMANIS_HEALTH", "FR_HARMONIE_MUTUELLE_HEALTH", "FR_ALAN_HEALTH", "FR_AESIO_MUTUELLE_HEALTH", "FR_AG2R_LA_MONDIALE_HEALTH" ], "type": "string" }, "type": "array", "uniqueItems": true }, "companyDisplayName": { "description": "Company display name, for displaying to users.", "example": "Aviva", "minLength": 1, "type": "string" }, "companyGroup": { "description": "The name of the group that a company or integration belongs to", "example": "SEB", "type": "string" }, "companyLinks": { "additionalProperties": { "type": "string" }, "description": "Company-specific links such as contact forms or other external resources", "example": "{'contactFormLink': 'https://example.com/contact'", "type": "object" }, "consentRequirements": { "description": "The set of consents required for initiating collections from this company.", "items": { "$ref": "#/components/schemas/ConsentRequirement" }, "type": "array", "uniqueItems": true }, "functional": { "description": "Whether or not it is possible to collect data from the company currently.", "example": false, "type": "boolean" }, "loginConfig": { "$ref": "#/components/schemas/CompanyLoginConfig", "description": "Configuration options for different login methods." }, "loginMethods": { "description": "Available login methods for the company.", "example": "USERNAME_AND_PASSWORD", "items": { "enum": [ "USERNAME_AND_PASSWORD", "PDF_UPLOAD", "AUTHENTICATION_APP_URL", "MANUAL_SELECT" ], "type": "string" }, "type": "array", "uniqueItems": true }, "nonFunctionalLoginMethods": { "description": "Disabled login methods for the company.", "example": "USERNAME_AND_PASSWORD", "items": { "enum": [ "USERNAME_AND_PASSWORD", "PDF_UPLOAD", "AUTHENTICATION_APP_URL", "MANUAL_SELECT" ], "type": "string" }, "type": "array", "uniqueItems": true }, "notifications": { "additionalProperties": { "type": "string" }, "description": "Company-specific notifications configuration", "example": "{'LOADING_SCREEN': 'SIGNIN_WARNING'}", "type": "object" }, "reason": { "description": "Reason for data collection being non-functional at present.", "enum": [ "THIRD_PARTY_ERROR", "THIRD_PARTY_UPDATE", "INSURELY_ERROR", "INSURELY_UPDATE", "RECONSTRUCTION" ], "example": "THIRD_PARTY_ERROR", "type": "string" }, "resetCredentials": { "additionalProperties": { "type": "string" }, "description": "Reset links to reset credentials for the company.", "example": "{'resetUsernameUrl': 'https://insurely.com/forgot-username', 'resetPasswordUrl': 'https://insurely.com/forgot-password'}", "type": "object" }, "status": { "description": "Status indicating the quality of the data collection for this company. A company has status BETA until we can\nguarantee the data quality and stability of it, after which its status is set to OK. Once taken out of BETA\nit cannot be set to BETA again.\n", "enum": [ "OK", "BETA", "NOT_IMPLEMENTED" ], "example": "OK", "type": "string" }, "supportsPreheating": { "description": "Whether the company supports starting a collection without user input.\nRequires input to be passed in at a later stage through the supplemental-info endpoint.\n", "type": "boolean" } }, "required": [ "additionalLoginInputs", "availableCoverageScopes", "company", "companyAndLineOfBusinesses", "companyDisplayName", "consentRequirements", "functional", "loginMethods", "nonFunctionalLoginMethods", "status", "supportsPreheating" ] }, "CompanyLoginConfig": { "properties": { "passwordFieldPlaceholder": { "enum": [ "PASSWORD", "CONFIDENTIAL_CODE", "PERSONAL_CODE", "SECRET_CODE", "MEMBERSHIP_NUMBER", "PIN_OR_PASSWORD" ], "type": "string" }, "passwordLabel": { "enum": [ "PASSWORD", "CONFIDENTIAL_CODE", "PERSONAL_CODE", "SECRET_CODE", "MEMBERSHIP_NUMBER", "PIN_OR_PASSWORD" ], "type": "string" }, "usernameFieldPlaceholder": { "enum": [ "EMAIL", "IDENTIFICATION_NUMBER_11", "IDENTIFICATION_CHARACTERS_8", "EMAIL_MOBILE_MUTUAL_MEMBER", "EMAIL_MOBILE_CLIENT", "EMAIL_MUTUAL_OR_REGULAR_MEMBER", "EMAIL_MOBILE_CONTRACT", "EMAIL_OR_MEMBER", "CLIENT_NUMBER", "LAST_NAME" ], "type": "string" }, "usernameLabel": { "enum": [ "EMAIL", "USERNAME", "CLIENT_NUMBER", "LAST_NAME" ], "type": "string" } } }, "ConsentRequestInput": { "description": "Represents a specific consent provided by the end user.", "properties": { "type": { "description": "The type of consent.", "enum": [ "TRADE_UNION_MEMBERSHIP" ], "example": "TRADE_UNION_MEMBERSHIP", "type": "string" } }, "required": [ "type" ] }, "ConsentRequirement": { "description": "The requirement for collect a specific consent.", "properties": { "method": { "description": "What method to use to collect the consent.", "enum": [ "NONE", "NOTICE", "ACTIVE" ], "example": "ACTIVE", "type": "string" }, "type": { "description": "The consent type.", "enum": [ "TRADE_UNION_MEMBERSHIP" ], "example": "TRADE_UNION_MEMBERSHIP", "type": "string" } }, "required": [ "method", "type" ] }, "Cookie": { "description": "A description of an HTTP cookie.", "properties": { "domain": { "description": "Domain of the cookie.", "example": ".insurely.com", "type": "string" }, "httpOnly": { "description": "Whether the cookie is set to httpOnly or not.", "example": false, "type": "boolean" }, "name": { "description": "Name of the cookie.", "example": "COOKIE_CONSENT", "type": "string" }, "path": { "description": "Path of the cookie.", "example": "/", "type": "string" }, "secure": { "description": "Whether the cookie is secure or not.", "example": true, "type": "boolean" }, "value": { "description": "Value of the cookie.", "example": "1", "type": "string" } } }, "CoreInsurancePerson": { "allOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "description": "Insurances with insurance type `personInsurance` and subtype `travelInsurance` or `healthInsurance`.", "properties": { "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "CoreInsurancePerson", "x-tag": "Insurance Type" }, "Coverage": { "description": "Insurance coverage details", "properties": { "documents": { "items": { "$ref": "#/components/schemas/ApiCoverageDocument" }, "type": "array" }, "isVersionRequested": { "type": "boolean" }, "parameters": { "description": "The parameter mapping of the insurance coverage", "items": { "$ref": "#/components/schemas/InsuranceParameterValue" }, "type": "array" }, "requestedVersionId": { "type": "string" }, "returnedVersionId": { "type": "string" } } }, "CoverageParameterValueDeductible": { "description": "The amount that you have to pay yourself in the event of a claim.", "discriminator": { "propertyName": "insurance-parameters" }, "properties": { "deductibleType": { "description": "How the deductible should be interpreted:\n- **amount**: A fixed monetary deductible.\n- **general**: A deductible that follows the insurer’s standard rules for this coverage type.The value may be the contract’s default deductible or a personalised override.\n- **not-applicable**: The deductible does not apply for the coverage.\n- **complex**: A deductible defined by a formula.", "enum": [ "amount", "complex", "general", "not-applicable" ], "example": "amount", "title": "Coverage Parameter Value Deductible Type", "type": "string" }, "description": { "description": "How the deductible applies, such as conditions, exceptions, or cases where no deductible is charged.", "example": "Except for bodily injury", "type": "string" }, "displayValue": { "description": "The personalised deductible amount, if available for the policy,else this will match `originalDisplayValue`.", "example": "500", "type": "string" }, "originalDisplayValue": { "description": "The deductible value defined by the insurer’s standard contract terms.", "example": "750", "type": "string" }, "personalised": { "description": "Indicates whether the deductible reflects a personalised amount for the specific policy.", "example": false, "type": "boolean" } }, "title": "Coverage Parameter Value Deductible" }, "CoverageParameterValueLimit": { "description": "The maximum amount that can be paid out in the event of a claim.", "discriminator": { "propertyName": "insurance-parameters" }, "properties": { "description": { "description": "The longer explanation of what the limit is.", "example": "20% of the insured amount", "type": "string" }, "displayValue": { "description": "The formatted and translated value of the limit.", "example": "Complex", "type": "string" }, "limitType": { "description": "The type of the limit.", "enum": [ "amount", "complex", "full-value", "no-limit", "not-applicable" ], "example": "full-value", "title": "Coverage Parameter Value Limit Type", "type": "string" } }, "title": "Coverage Parameter Limit" }, "Deductible": { "description": "A specific deductible with its amount value for a specific insurance. The deductibleIds can be used for looking up when using the API, while the names might be localized in a way that makes them hard to use. The amount value is in the same currency as the insurance. The list relates to reference for possible values of the IDs for different insurance types.", "discriminator": { "propertyName": "insurance-parameters" }, "properties": { "deductibleAmount": { "description": "The deductible amount in local currency or percent", "example": 1500, "format": "int32", "type": "integer" }, "deductibleId": { "description": "The technical name of the deductible, standardized across different companies.", "example": "deductibleFixed", "type": "string" }, "deductibleName": { "description": "Localized name of the deductible, can be used as display name.", "example": "Fixed deductible", "type": "string" } }, "title": "Insurance Deductible" }, "Document": { "description": "A document associated with a policy.", "discriminator": { "propertyName": "insurance-parameters" }, "properties": { "id": { "description": "An id uniquely identifying a document within a policy and collection.", "example": "5c7e3f0c-62ec-46cd-8d86-12b05ed654d1", "type": "string" }, "type": { "description": "The type of the document.", "example": "INSURANCE_LETTER", "type": "string" } }, "title": "Document" }, "ErrorResponse": { "description": "Standard error response returned by the API when a request fails.", "properties": { "errors": { "description": "Field-level validation errors, empty when not applicable.", "items": { "$ref": "#/components/schemas/InsurelyInputError" }, "type": "array" }, "localizedMessage": { "description": "Localized version of the error message, if available.", "example": "Invalid request", "type": "string" }, "message": { "description": "Human-readable error message.", "example": "Invalid request", "type": "string" }, "status": { "description": "HTTP status name.", "example": "BAD_REQUEST", "type": "string" }, "statusCode": { "description": "HTTP status code.", "example": 400, "format": "int32", "type": "integer" } } }, "FarmProperty": { "description": "An additional property included in the `farmInsurance`.", "properties": { "buildingType": { "description": "The type of the additional building.", "enum": [ "BARN", "STABLE", "LOG_CABIN", "MACHINE_HALL", "UNKNOWN" ], "example": "BARN", "type": "string" } }, "title": "Farm property" }, "FrenchDriverInformation": { "description": "Information about a driver registered on a French vehicle insurance policy", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "birthDate": { "description": "The birth date of the driver", "example": "1999-12-31", "type": "string" }, "licenseIssuingDate": { "description": "The issuing date of the driver's license", "example": "2008-12-21", "type": "string" }, "name": { "description": "The name of the driver", "example": "Cornélie Boivin", "type": "string" } }, "title": "FrenchDriverInformation", "x-markets": { "fr": true } }, "FrenchOutbuildingsArea": { "allOf": [ { "$ref": "#/components/schemas/FrenchOutbuildingsTotalArea" } ], "description": "The total surface area of outbuildings.", "properties": { "area": { "description": "The area of the building", "example": 10, "format": "int32", "type": "integer" } }, "x-markets": { "fr": true } }, "FrenchOutbuildingsAreaRange": { "allOf": [ { "$ref": "#/components/schemas/FrenchOutbuildingsTotalArea" } ], "description": "The total surface area range of outbuildings.", "properties": { "lowerLimit": { "description": "The minimum size of the building", "example": 10, "format": "int32", "type": "integer" }, "upperLimit": { "description": "The max size of the building", "example": 10, "format": "int32", "type": "integer" } }, "x-markets": { "fr": true } }, "FrenchOutbuildingsTotalArea": { "discriminator": { "mapping": { "area": "#/components/schemas/FrenchOutbuildingsArea", "area-range": "#/components/schemas/FrenchOutbuildingsAreaRange" }, "propertyName": "@type" }, "oneOf": [ { "$ref": "#/components/schemas/FrenchOutbuildingsArea" }, { "$ref": "#/components/schemas/FrenchOutbuildingsAreaRange" } ], "properties": { "@type": { "type": "string" } }, "title": "FrenchOutbuildingsTotalArea", "x-markets": { "fr": true } }, "FrenchParkingAddress": { "description": "A French parking address", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "city": { "description": "The city the address is located in", "example": "Paris", "type": "string" }, "postalCode": { "description": "The postal code of the parking address", "example": "80495", "type": "string" }, "street": { "description": "The street address", "example": "34", "type": "string" } }, "title": "FrenchParkingAddress", "x-markets": { "fr": true } }, "FrenchParkingLocation": { "description": "Details about the parking location of a vehicle insured in France", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "parkingAddress": { "$ref": "#/components/schemas/FrenchParkingAddress" }, "parkingLocationType": { "description": "The type of location the vehicle is most commonly parked at", "enum": [ "STREET", "COMMON_GARAGE", "INDIVIDUAL_GARAGE", "PRIVATE_PROPERTY", "UNKNOWN" ], "example": "INDIVIDUAL_GARAGE", "type": "string" } }, "title": "FrenchParkingLocation", "x-markets": { "fr": true } }, "FrenchPremium": { "allOf": [ { "$ref": "#/components/schemas/Premium" } ], "properties": { "taxation": { "description": "Whether taxation is a part of the premium or not.", "enum": [ "INCLUSIVE_TAXATION", "EXCLUSIVE_TAXATION", "UNKNOWN_TAXATION" ], "example": "INCLUSIVE_TAXATION", "type": "string" } } }, "FullInsuranceWrapper": { "description": "The insurance wrapper contains the insurance, its deductibles, addons, and general coverage as separate fields.\n", "discriminator": { "propertyName": "insurance" }, "properties": { "addons": { "description": "A list of addons that this insurance has", "items": { "$ref": "#/components/schemas/AddOn" }, "type": "array" }, "coverage": { "$ref": "#/components/schemas/Coverage", "description": "The coverage details of the insurance, including parameters" }, "deductibles": { "description": "A list of deductibles associated with the insurance", "items": { "$ref": "#/components/schemas/Deductible" }, "type": "array" }, "documents": { "description": "A list of documents associated with the insurance", "items": { "$ref": "#/components/schemas/Document" }, "type": "array" }, "id": { "description": "Unique identifier for the insurance.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insurance": { "$ref": "#/components/schemas/InsuranceWrapper", "description": "The basic insurance data collected from the insurance company" }, "personalInformation": { "additionalProperties": {}, "description": "A map of personal information for the person who collected data. E.g. personal number.", "type": "object" }, "termsUrl": { "description": "URL to the current insurance terms as a PDF, will be missing if there is no link.", "example": "/coverage/terms?filePath=se/condoInsurance/se-demo/term_hemförsäkring mellan_2025-01-01.pdf", "type": "string" } }, "required": [ "id" ], "title": "Full Insurance Wrapper" }, "Holder": { "description": "Information about the insurance holder", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "city": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "dateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "email": { "description": "The email address of the insurance holder - disabled by default", "example": "abc@insurely.com", "type": "string" }, "firstName": { "description": "The first name of the insurance holder", "example": "Firstname", "type": "string" }, "gender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "lastName": { "description": "The last name of the insurance holder", "example": "Lastname", "type": "string" }, "name": { "description": "The full name of the insurance holder", "example": "Firstname Lastname", "type": "string" }, "phoneNumber": { "description": "The phone number of the insurance holder - disabled by default", "example": "+01234567890", "type": "string" }, "postalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "streetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" } } }, "InstructionsRequestObject": { "description": "The instructions request object included in the `CollectionStatusInformationMap` for the `SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION` login method.", "properties": { "request": { "$ref": "#/components/schemas/Request" } }, "required": [ "request" ] }, "Insurance": { "discriminator": { "mapping": { "hidden": "#/components/schemas/Insurance" }, "propertyName": "insurance" }, "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ] }, "InsuranceAccident": { "description": "Accident insurances are of insurance type `personInsurance` and subtype `accidentInsurance`\n", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceAccident", "x-tag": "Insurance Type" }, "InsuranceAnimal": { "description": "Animal insurances are of insurance type `animalInsurance` with the following possible subtypes:\n* `dogInsurance`\n* `catInsurance`\n* `horseInsurance`\n* `otherAnimalInsurance`\n", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "animalBreed": { "description": "The breed of the animal.", "example": "Golden retriever", "type": "string" }, "animalGender": { "description": "The gender of the animal.", "enum": [ "MALE", "FEMALE", "CASTRATED_MALE", "CASTRATED_FEMALE", "UNKNOWN" ], "example": "MALE", "type": "string" }, "animalName": { "description": "The name of the animal.", "example": "Loulou", "type": "string" }, "chipNumber": { "description": "The animal's chip number.", "example": "123456789ASD123", "type": "string" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "dateOfBirth": { "description": "The animal's date of birth.", "example": "2018-12-01", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" }, "veterinaryCareAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The maximum reimbursed veterinary care amount per insurance period." }, "veterinaryCareAmountRemaining": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The remaining veterinary care amount for the insurance period." }, "veterinaryCareCoverage": { "description": "The veterinary care covered percentage for the insurance period.", "example": 80, "format": "int32", "type": "integer" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceAnimal", "x-tag": "Insurance Type" }, "InsuranceCar": { "description": "Car insurances are of insurance type `vehicleInsurance` with the subtype `carInsurance`.", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "bonusMalus": { "$ref": "#/components/schemas/BonusMalus", "description": "Bonus/Malus on the insurance policy" }, "brand": { "description": "Brand of the insured vehicle", "example": "Volvo", "type": "string" }, "claims": { "$ref": "#/components/schemas/Claims", "description": "Enabled by feature flag" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "coverage": { "enum": [ "UNDEFINED", "FULL_WITH_CHASSI", "FULL_WITHOUT_CHASSI", "TRAFFIC", "NOT_IN_TRAFFIC", "CASCO", "MTPL", "THIRD_PARTY", "THIRD_PARTY_PLUS" ], "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "maxMileage": { "description": "Max mileage per year that the insurance covers in km.", "example": 10000, "format": "int32", "type": "integer" }, "model": { "description": "Insured vehicle model", "example": "S60", "type": "string" }, "parking": { "$ref": "#/components/schemas/FrenchParkingLocation", "description": "Details about the parking location of the vehicle covered by the insurance policy" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "primaryDriver": { "$ref": "#/components/schemas/FrenchDriverInformation", "description": "The primary driver registered on the insurance policy" }, "registrationNo": { "description": "Registration number for vehicle", "example": "ABC000", "type": "string" }, "secondaryDrivers": { "description": "Any additional drivers registered on the insurance policy", "items": { "$ref": "#/components/schemas/FrenchDriverInformation" }, "type": "array", "uniqueItems": true }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" }, "termsAndConditionsVersion": { "$ref": "#/components/schemas/TermsAndConditionsVersion" }, "usedForWork": { "description": "The insurance covers the vehicle if it is used for work.", "example": false, "type": "boolean" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceCar", "x-markets": { "fr": true }, "x-tag": "Insurance Type" }, "InsuranceChild": { "allOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "description": "Child insurances are of insurance type `personInsurance` and subtype `childInsurance`", "properties": { "insuredAmountBaseEconomicalDisability": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The base amount for economical disability compensation. The compensation for specific injuries are based on this amount.\n" }, "insuredAmountBaseMedicalDisability": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The base amount for medical disability compensation. The compensation for specific injuries are based on this amount.\n" }, "insuredAmountLife": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The compensation if the child is to decease." }, "insuredAmountMaxMedicalDisability": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The maximum compensation for a medical disability. A multiple of the base amount.\n" }, "insuredPersonDateOfBirth": { "description": "Date of birth of the insured child in the format YYYY-MM-DD. Only available for some companies; absent when it could not be determined.\n", "example": "2016-02-20", "type": "string" }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceChild", "x-tag": "Insurance Type" }, "InsuranceCottage": { "description": "Cottage insurances are of insurance type `houseContentInsurance` and subtype `cottageInsurance`", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "additionalBuildings": { "description": "Information about any additional buildings on the property.", "items": { "$ref": "#/components/schemas/AdditionalBuilding" }, "type": "array" }, "ancillaryArea": { "description": "Ancillary area in square meters rounded to nearest integer.", "example": 72, "format": "int32", "type": "integer" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "connectedAlarmDiscount": { "description": "Discount related to having a connected alarm system.", "example": true, "type": "boolean" }, "constructionYear": { "description": "The year the residence was built.", "example": "1910", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "hasBasement": { "description": "Whether the residence has a basement.", "example": true, "type": "boolean" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceObjectCity": { "description": "City where the insured object is located", "example": "Stockholm", "type": "string" }, "insuranceObjectPostalCode": { "description": "Postal code of the insured object", "example": "12345", "type": "string" }, "insuranceObjectPropertyCode": { "description": "Property code of the insured object", "example": "Blåbäret 1:10", "type": "string" }, "insuranceObjectStreetAddress": { "description": "Street address of the insured object", "example": "Hallonvägen 3", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "insuredMovablesAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Maximum compensation for movable property." }, "livingArea": { "description": "Living area in square meters", "example": 72, "format": "int32", "type": "integer" }, "numberOfBathrooms": { "description": "Number of bathrooms in the residence.", "example": 3, "format": "int32", "type": "integer" }, "numberOfFloors": { "description": "Number of floors in the residence.", "example": 4, "format": "int32", "type": "integer" }, "numberOfResidents": { "description": "Number of people living in the residence.", "example": 3, "format": "int32", "type": "integer" }, "numberOfToilets": { "description": "Number of toilets in the residence.", "example": 4, "format": "int32", "type": "integer" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "purchaseYear": { "description": "The year the residence was purchased.", "example": "1995", "type": "string" }, "rental": { "description": "Whether the insurance holder rents the residence.", "example": false, "type": "boolean" }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceFarm": { "description": "Farm insurances are of insurance type `houseContentInsurance` and subtype `farmInsurance`", "properties": { "additionalBuildings": { "description": "Information about any additional buildings on the property", "items": { "$ref": "#/components/schemas/AdditionalBuilding" }, "type": "array" }, "ancillaryArea": { "description": "Ancillary area in square meters rounded to nearest integer.", "example": 72, "format": "int32", "type": "integer" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "connectedAlarmDiscount": { "description": "Discount related to having a connected alarm system.", "example": true, "type": "boolean" }, "constructionYear": { "description": "The year the residence was built.", "example": "1910", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "farmProperties": { "items": { "$ref": "#/components/schemas/FarmProperty" }, "type": "array" }, "hasBasement": { "description": "Whether the residence has a basement.", "example": true, "type": "boolean" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceObjectCity": { "description": "City where the insured abject is located", "example": "Stockholm", "type": "string" }, "insuranceObjectPostalCode": { "description": "Postal code of the insured object", "example": "12345", "type": "string" }, "insuranceObjectPropertyCode": { "description": "Property code of the insured object", "example": "Blåbäret 1:10", "type": "string" }, "insuranceObjectStreetAddress": { "description": "Street address of the insured object", "example": "Blåbärsvägen 3", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "insuredMovablesAmount": { "description": "Maximum compensation for moveable property.", "example": 1500000, "format": "int32", "type": "integer" }, "livingArea": { "description": "Living area in square meters rounded to nearest integer.", "example": 72, "format": "int32", "type": "integer" }, "numberOfBathrooms": { "description": "Number of bathrooms in the residence.", "example": 3, "format": "int32", "type": "integer" }, "numberOfFloors": { "description": "Number of floors in the residence.", "example": 4, "format": "int32", "type": "integer" }, "numberOfResidents": { "description": "Number of people living in the residence.", "example": 3, "format": "int32", "type": "integer" }, "numberOfToilets": { "description": "Number of toilets in the residence.", "example": 4, "format": "int32", "type": "integer" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "purchaseYear": { "description": "The year the residence was purchased.", "example": "1995", "type": "string" }, "rental": { "description": "Whether the insurance holder rents the residence.", "example": false, "type": "boolean" }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceGeneral": { "description": "General insurances are of insurance type `generalInsurance` and subtype `genericInsurance`", "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insurance": { "description": "Basic insurance information" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceHome": { "description": "Home insurances are of insurance type `houseContentInsurance` and subtype `condoInsurance`", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "additionalAmenities": { "description": "Which amenities are available in the home.", "example": "FIREPLACE", "items": { "enum": [ "FIREPLACE", "POOL", "GARDEN", "SAFETY_ALARM", "FIRE_ALARM", "SOLAR_PANEL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "claims": { "$ref": "#/components/schemas/Claims", "description": "Enabled by feature flag" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "floor": { "description": "The category of floor the home is located on,", "enum": [ "GROUND_FLOOR", "COURTYARD", "INTERMEDIATE_FLOOR", "TOP_FLOOR", "UNKNOWN" ], "example": "TOP_FLOOR", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceObjectCity": { "description": "City where the insured object is located", "example": "Stockholm", "type": "string" }, "insuranceObjectPostalCode": { "description": "Postal code of the insured object", "example": "12345", "type": "string" }, "insuranceObjectStreetAddress": { "description": "Street address of the insured object", "example": "Hallonvägen 3", "type": "string" }, "insurancePreviouslyRefused": { "description": "Whether insurance coverage has been refused for this person.", "example": false, "type": "boolean" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "insuredMovablesAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Maximum compensation for movable property." }, "insuredValuablesAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Maximum compensation for valuable property." }, "livingArea": { "description": "Living area in square meters", "example": 72, "format": "int32", "type": "integer" }, "numberOfAdults": { "description": "The number of adults residing in the home.", "example": 2, "format": "int32", "type": "integer" }, "numberOfChildren": { "description": "The number of children residing in the home.", "example": 2, "format": "int32", "type": "integer" }, "numberOfResidents": { "description": "Number of people living in the residence.", "example": 3, "format": "int32", "type": "integer" }, "numberOfRooms": { "description": "The number of rooms in the home.", "example": 4, "format": "int32", "type": "integer" }, "outbuildingsTotalArea": { "$ref": "#/components/schemas/FrenchOutbuildingsTotalArea", "description": "The total surface area of outbuildings." }, "ownershipStatus": { "description": "Whether the home is owned by the insurance holder.", "enum": [ "OWNER", "TENANT", "SECONDARY_TENANT", "UNKNOWN" ], "example": "OWNER", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "professionalUsage": { "description": "Whether the property is used for business purposes.", "example": false, "type": "boolean" }, "residentialStatus": { "description": "Who resides in the home.", "enum": [ "PRIMARY_RESIDENCE", "SECONDARY_RESIDENCE", "RENTAL_RESIDENCE", "UNKNOWN" ], "example": "PRIMARY_RESIDENCE", "type": "string" }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" }, "termsAndConditionsVersion": { "$ref": "#/components/schemas/TermsAndConditionsVersion" } }, "title": "InsuranceHome", "x-tag": "Insurance Type" }, "InsuranceHouseContent": { "description": "Contents insurances are of insurance type `houseContentInsurance` with the following possible subtypes:\n* `condoInsurance`\n* `villaInsurance`\n* `cottageInsurance`\n", "discriminator": { "mapping": { "condoInsurance": "#/components/schemas/InsuranceHome", "cottageInsurance": "#/components/schemas/InsuranceCottage", "villaInsurance": "#/components/schemas/InsuranceVilla" }, "propertyName": "insuranceSubType" }, "oneOf": [ { "$ref": "#/components/schemas/InsuranceHome" }, { "$ref": "#/components/schemas/InsuranceVilla" } ], "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceObjectCity": { "description": "City where the insured object is located", "example": "Stockholm", "type": "string" }, "insuranceObjectPostalCode": { "description": "Postal code of the insured object", "example": "12345", "type": "string" }, "insuranceObjectStreetAddress": { "description": "Street address of the insured object", "example": "Hallonvägen 3", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "insuredMovablesAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Maximum compensation for movable property." }, "livingArea": { "description": "Living area in square meters", "example": 72, "type": "number" }, "numberOfResidents": { "description": "Number of people living in the residence.", "example": 3, "format": "int32", "type": "integer" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceHouseContent" }, "InsuranceIncome": { "description": "Income insurances are of insurance type `incomeInsurance` with the following possible subtypes:\n* `incomeInsurance`\n* `sicknessInsurance`\n* `loanInsurance`\n", "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "insuredAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Selected insurance amount which a lump sum payout is based on. Only applicable for certain income insurance types\n" }, "insuredMonthlyAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Monthly payment amount." }, "numberOfDaysUntilFirstPayout": { "description": "Number of days from unemployment/sickness until first payout", "example": 30, "format": "int32", "type": "integer" }, "numberOfDaysUntilLastPayout": { "description": "Number of days from unemployment/sickness until last payout", "example": 180, "format": "int32", "type": "integer" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "qualifyingPeriodDays": { "description": "Number of working days before qualified for payouts", "example": 180, "format": "int32", "type": "integer" }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "Income insurance", "x-tag": "Insurance Type" }, "InsuranceLife": { "allOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "description": "Life insurances are of insurance type `personInsurance` and subtype `lifeInsurance`", "properties": { "insuredAmountLife": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Insured amount." }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceLife", "x-tag": "Insurance Type" }, "InsuranceOtherVehicle": { "description": "Other vehicle insurances are of insurance type `vehicleInsurance` with the following possible subtypes:\n* `boatInsurance`\n* `caravanInsurance`\n* `mopedInsurance`\n* `motorHomeInsurance`\n* `motorcycleInsurance`\n* `otherVehicleInsurance`\n* `trailerInsurance`\n", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "brand": { "description": "Brand of the insured vehicle", "example": "Volvo", "type": "string" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "model": { "description": "Insured vehicle model", "example": "S60", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "registrationNo": { "description": "Registration number for vehicle", "example": "ABC000", "type": "string" }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceOtherVehicle", "x-tag": "Insurance Type" }, "InsuranceParameterValue": { "description": "A parameter value for a specific insurance. Describes one insurance element for a specific insurance as well as if it's included or not. Contains a technical name, a display name, a description in the local language and the value for the specific insurance.", "discriminator": { "propertyName": "insurance-parameters" }, "properties": { "isAddonPurchased": { "description": "The value has been changed to true because the collected insurance has the addon.", "example": true, "type": "boolean" }, "parameterDeductible": { "$ref": "#/components/schemas/CoverageParameterValueDeductible" }, "parameterDescription": { "description": "Description of the parameter in the local language.", "example": "Compensates you if your car is stolen or damaged in a theft or a break-in.", "type": "string" }, "parameterDisplayName": { "description": "Display name for the parameter presented in the local language.", "example": "Theft", "type": "string" }, "parameterGroup": { "description": "The group the parameter belongs to.", "example": "Basic coverage", "type": "string" }, "parameterGroupOrder": { "description": "The display order of the parameter group.", "example": 1, "format": "int32", "type": "integer" }, "parameterLimit": { "$ref": "#/components/schemas/CoverageParameterValueLimit" }, "parameterName": { "description": "The name of the parameter as returned for a specific insurance. In english.", "example": "theft", "type": "string" }, "parameterOrder": { "description": "The display order of the parameter within the parameter group.", "example": 2, "format": "int32", "type": "integer" }, "value": { "description": "Potential values are `true` (parameter included in insurance coverage), `false` (parameter not included in insurance coverage) or `possible` (parameter could be included in coverage but we are unable to determine for certain)", "example": true, "type": "string" } }, "title": "Insurance Parameter Value" }, "InsurancePerson": { "allOf": [ { "$ref": "#/components/schemas/Insurance" } ], "description": "Person insurances are of insurance type `personInsurance` with the following possible subtypes:\n* `childInsurance`\n* `lifeInsurance`\n* `accidentInsurance`\n* `pregnancyInsurance`\n* `healthInsurance`\n* `travelInsurance`\n", "discriminator": { "mapping": { "accidentInsurance": "#/components/schemas/InsuranceAccident", "childInsurance": "#/components/schemas/InsuranceChild", "healthInsurance": "#/components/schemas/CoreInsurancePerson", "lifeInsurance": "#/components/schemas/InsuranceLife", "pregnancyInsurance": "#/components/schemas/InsurancePregnancy", "travelInsurance": "#/components/schemas/CoreInsurancePerson" }, "propertyName": "insuranceSubType" }, "oneOf": [ { "$ref": "#/components/schemas/InsuranceChild" }, { "$ref": "#/components/schemas/InsuranceLife" }, { "$ref": "#/components/schemas/InsuranceAccident" }, { "$ref": "#/components/schemas/InsurancePregnancy" }, { "$ref": "#/components/schemas/CoreInsurancePerson" } ], "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsurancePerson", "x-tag": "Insurance Type" }, "InsurancePregnancy": { "allOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "description": "Pregnancy insurances are of insurance type `personInsurance` and subtype `pregnancyInsurance`", "properties": { "insuredAmountBaseMedicalDisability": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The base amount for medical disability compensation. The compensation for specific injuries are based on this amount.\n" }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsurancePregnancy", "x-tag": "Insurance Type" }, "InsuranceTypeAndSubtype": { "properties": { "insuranceSubType": { "description": "The specific insurance subtype", "enum": [ "carInsurance", "boatInsurance", "trailerInsurance", "motorcycleInsurance", "mopedInsurance", "caravanInsurance", "motorhomeInsurance", "otherVehicleInsurance", "childInsurance", "pregnancyInsurance", "lifeInsurance", "healthInsurance", "accidentInsurance", "travelInsurance", "condoInsurance", "contentsInsurance", "villaInsurance", "cottageInsurance", "farmInsurance", "catInsurance", "dogInsurance", "horseInsurance", "otherAnimalInsurance", "genericInsurance", "groupInsurance", "incomeInsurance", "sicknessInsurance", "loanInsurance", "landlordInsurance" ], "example": "CAR_INSURANCE", "type": "string" }, "insuranceType": { "description": "The main insurance type category", "enum": [ "vehicleInsurance", "houseContentInsurance", "personInsurance", "animalInsurance", "groupInsurance", "generalInsurance", "incomeInsurance" ], "example": "VEHICLE_INSURANCE", "type": "string" } } }, "InsuranceVehicle": { "description": "Vehicle insurances are of insurance type `vehicleInsurance` with the following possible subtypes:\n* `boatInsurance`\n* `carInsurance`\n* `caravanInsurance`\n* `mopedInsurance`\n* `motorHomeInsurance`\n* `motorcycleInsurance`\n* `otherVehicleInsurance`\n* `trailerInsurance`\n", "discriminator": { "mapping": { "carInsurance": "#/components/schemas/InsuranceCar", "otherVehicleInsurance": "#/components/schemas/InsuranceOtherVehicle" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/InsuranceCar" }, { "$ref": "#/components/schemas/InsuranceOtherVehicle" } ], "properties": { "brand": { "description": "Brand of the insured vehicle", "example": "Volvo", "type": "string" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "model": { "description": "Insured vehicle model", "example": "S60", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "registrationNo": { "description": "Registration number for vehicle", "example": "ABC000", "type": "string" }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" } }, "required": [ "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceVehicle" }, "InsuranceVilla": { "description": "Villa insurances are of insurance type `houseContentInsurance` and subtype `villaInsurance`\n", "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "dk", "ee", "fr", "lv", "no", "se", "uk", "core" ], "example": "core", "title": "@market" }, "additionalAmenities": { "description": "Which amenities are available in the home.", "example": "FIREPLACE", "items": { "enum": [ "FIREPLACE", "POOL", "GARDEN", "SAFETY_ALARM", "FIRE_ALARM", "SOLAR_PANEL" ], "type": "string" }, "type": "array", "uniqueItems": true }, "claims": { "$ref": "#/components/schemas/Claims", "description": "Enabled by feature flag" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "holder": { "$ref": "#/components/schemas/Holder", "description": "Information about the registered insurance holder" }, "insuranceCompany": { "$ref": "#/components/schemas/Company", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceName": { "description": "Name of insurance as stated by the insurance companies' systems", "example": "Content insurance", "type": "string" }, "insuranceNumber": { "description": "Reference number for insurance at respective insurance company", "example": "123456-789", "type": "string" }, "insuranceObjectCity": { "description": "City where the insured object is located", "example": "Stockholm", "type": "string" }, "insuranceObjectPostalCode": { "description": "Postal code of the insured object", "example": "12345", "type": "string" }, "insuranceObjectStreetAddress": { "description": "Street address of the insured object", "example": "Hallonvägen 3", "type": "string" }, "insurancePreviouslyRefused": { "description": "Whether insurance coverage has been refused for this person.", "example": false, "type": "boolean" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "insuredMovablesAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Maximum compensation for movable property." }, "insuredValuablesAmount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "Maximum compensation for valuable property." }, "livingArea": { "description": "Living area in square meters", "example": 72, "format": "int32", "type": "integer" }, "numberOfAdults": { "description": "The number of adults residing in the home.", "example": 2, "format": "int32", "type": "integer" }, "numberOfChildren": { "description": "The number of children residing in the home.", "example": 2, "format": "int32", "type": "integer" }, "numberOfResidents": { "description": "Number of people living in the residence.", "example": 3, "format": "int32", "type": "integer" }, "numberOfRooms": { "description": "The number of rooms in the home.", "example": 4, "format": "int32", "type": "integer" }, "outbuildingsTotalArea": { "$ref": "#/components/schemas/FrenchOutbuildingsTotalArea", "description": "The total surface area of outbuildings." }, "ownershipStatus": { "description": "Whether the home is owned by the insurance holder.", "enum": [ "OWNER", "TENANT", "SECONDARY_TENANT", "UNKNOWN" ], "example": "OWNER", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "professionalUsage": { "description": "Whether the property is used for business purposes.", "example": false, "type": "boolean" }, "residentialStatus": { "description": "Who resides in the home.", "enum": [ "PRIMARY_RESIDENCE", "SECONDARY_RESIDENCE", "RENTAL_RESIDENCE", "UNKNOWN" ], "example": "PRIMARY_RESIDENCE", "type": "string" }, "startDate": { "description": "The start date of the insurance. Could be either original start date or period start date\n", "example": "2020-01-01", "type": "string" }, "termsAndConditionsVersion": { "$ref": "#/components/schemas/TermsAndConditionsVersion" } }, "title": "InsuranceVilla", "x-markets": { "fr": true }, "x-tag": "Insurance Type" }, "InsuranceWrapper": { "description": "Is one of a specific insurance subtype.", "discriminator": { "mapping": { "child-1": "#/components/schemas/InsuranceAnimal", "child-2": "#/components/schemas/InsuranceVehicle", "child-3": "#/components/schemas/InsurancePerson", "child-5": "#/components/schemas/InsuranceHouseContent", "child-6": "#/components/schemas/InsuranceCottage", "child-7": "#/components/schemas/InsuranceFarm", "child-8": "#/components/schemas/InsuranceGeneral" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/InsuranceAnimal" }, { "$ref": "#/components/schemas/InsuranceVehicle" }, { "$ref": "#/components/schemas/InsurancePerson" }, { "$ref": "#/components/schemas/InsuranceHouseContent" }, { "$ref": "#/components/schemas/InsuranceIncome" }, { "$ref": "#/components/schemas/InsuranceCottage" }, { "$ref": "#/components/schemas/InsuranceFarm" }, { "$ref": "#/components/schemas/InsuranceGeneral" } ], "title": "Insurance Wrapper" }, "InsurelyInputError": { "description": "Field-level validation errors, empty when not applicable." }, "Item": { "description": "The item object included in the `CollectionInput` for providing supplemental information", "properties": { "type": { "description": "The type of information provided", "enum": [ "EMAIL", "LOGIN_METHOD", "PASSWORD", "TRADE_UNION_MEMBERSHIP", "TWO_FACTOR_TOKEN", "USERNAME" ], "example": "EMAIL", "type": "string" }, "value": { "description": "The value for the corresponding type that is passed in for the item", "example": "abc@insurely.com", "minLength": 1, "type": "string" } }, "required": [ "value" ] }, "Market": { "description": "A market definition used to indicate market-specific API models. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "Market", "type": "string" }, "MonetaryAmount": { "description": "Defines a monetary amount, specified by its currency code and numerical value.", "properties": { "amount": { "description": "The numeric representation of the monetary value.", "example": 10.32, "type": "number" }, "currency": { "description": "The ISO 4217 standard currency code. Possible enums: DKK, EUR, GBP, NOK, SEK, USD, etc.", "example": "EUR", "type": "string" } }, "title": "Monetary Amount" }, "Premium": { "description": "A premium including the amount and period.", "discriminator": { "mapping": { "fr": "#/components/schemas/FrenchPremium" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/FrenchPremium" } ], "properties": { "@market": { "$ref": "#/components/schemas/Market", "description": "A meta property to indicate which specific insurance model to deserialize the response to. The value is the ISO 3166-1 alpha-2 country code, with the addition of the `core` market, used as default models where no market-specific one exists.\n", "enum": [ "fr", "core" ], "example": "core", "title": "@market" }, "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The premium amount." }, "paymentFrequency": { "description": "Frequency of premium payments, possible values are:\n`1` - annually, `2` - biannually, `4` - quarterly,\n`12` - monthly, `0` - one time payment or `-1` - unknown\n", "example": 12, "format": "int32", "type": "integer" }, "period": { "description": "The period with which this premium is based on.", "enum": [ "YEARLY_PREMIUM_PERIOD", "UNKNOWN_PREMIUM_PERIOD" ], "example": "YEARLY_PREMIUM_PERIOD", "type": "string" } } }, "Request": { "properties": { "body": { "description": "If the method is POST, body to be included in the POST request as string.", "example": "'{\"username\":\"19900101-1234\"}'", "type": "string" }, "cookies": { "description": "List of cookies to include in the request. They should be added to a cookie jar and included in each subsequent request.", "items": { "$ref": "#/components/schemas/Cookie" }, "type": "array" }, "etag": { "description": "Entity tag of the request, each unique request will have its own unique etag. This allows for distinguishing between new requests to be made,\nsince the same request may be \"returned with multiple `CollectionStatus` responses.", "example": "d5c19d129d9f4a54b7de2fa198bf73fa-initiate", "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Map of headers to include with the request.", "example": { "Content-Type": "application/json" }, "type": "object" }, "method": { "description": "HTTP method of the request.", "example": "POST", "type": "string" }, "url": { "description": "URL to make a request towards. This will be based on the company that the collection is started towards.", "example": "https://insurely.com/initiate-bankid", "type": "string" } }, "required": [ "url" ] }, "ResponseObject": { "description": "An HTTP response to be provided after receiving HTTP `INSTRUCTIONS` in the `CollectionStatus` `extraInformation` object. This is expected when using the `SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION` `loginMethod`. An in-depth description of this flow can be found in the introduction.", "properties": { "headers": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "description": "The keys and values of the response headers. Values are lists because some headers (notably Set-Cookie) will be repeated", "example": { "Cache-Control": [ "no-cache, no-store, max-age=0" ], "Content-Encoding": [ "gzip" ], "Content-Language": [ "sv_SE" ], "Content-Type": [ "application/json; charset=UTF-8" ], "Date": [ "Sun, 20 Jul 1969 20:17:10 GMT" ], "Expires": [ "Thu, 01 Jan 1970 00:00:00 GMT" ], "Pragma": [ "no-cache" ], "Server": [ "-" ], "Set-Cookie": [ "session=0cdd1666-7319-4f73-8fc3-d095f83b4ff9;Path=/;Domain=somecompany.se;Secure;HttpOnly", "qwerty=219ffwef9w0f; Domain=somecompany.se" ], "Strict-Transport-Security": [ "max-age=31536000; includeSubDomains" ], "Transfer-Encoding": [ "Identity" ], "Vary": [ "Accept-Encoding" ] }, "type": "object" }, "response": { "description": "The response body, in the format it was responded, e.g. html or json.", "example": { "andromedaUserToken": "some_random_token", "extendedUsage": false, "formattedServerTime": "1969-07-20 22:27", "links": { "next": { "method": "GET", "uri": "/v5/profile/" } }, "maskedUserId": "19300805****", "serverTime": "19690720 22:17", "status": "COMPLETE" } }, "type": { "enum": [ "RESPONSE_OBJECT" ], "example": "RESPONSE_OBJECT", "type": "string" } }, "title": "ResponseObject" }, "SelectOne": { "properties": { "key": { "type": "string" }, "options": { "items": { "$ref": "#/components/schemas/AdditionalLoginInputSelectOption" }, "type": "array", "uniqueItems": true }, "type": { "type": "string" } }, "required": [ "key", "options" ] }, "SupplementInformation": { "discriminator": { "mapping": { "COLLECTION_INPUT": "#/components/schemas/CollectionInput", "RESPONSE_OBJECT": "#/components/schemas/ResponseObject", "TWO_FACTOR_CHOICE": "#/components/schemas/TwoFactorChoice", "TWO_FACTOR_CODE": "#/components/schemas/TwoFactorCode" }, "propertyName": "api" }, "oneOf": [ { "$ref": "#/components/schemas/TwoFactorCode" }, { "$ref": "#/components/schemas/TwoFactorChoice" }, { "$ref": "#/components/schemas/ResponseObject" }, { "$ref": "#/components/schemas/CollectionInput" } ], "properties": { "type": { "description": "Type of the supplemental information.", "enum": [ "TWO_FACTOR_CODE", "TWO_FACTOR_CHOICE", "RESPONSE_OBJECT", "COLLECTION_INPUT" ], "type": "string" } }, "title": "SupplementInformation" }, "TermsAndConditionsVersion": { "description": "Active terms and conditions version", "properties": { "version": { "description": "Terms and conditions version", "example": "Home COM12345", "type": "string" } } }, "TwoFactorAuthenticationInstruction": { "description": "Instructions for two factor authentication. Add supplemental information to a collection if the `responseType` is not `NO_RESPONSE`.", "properties": { "authenticationInstruction": { "description": "Instructions text", "example": "Please authenticate with the following device: 's IPHONE 13", "type": "string" }, "responseType": { "description": "Expected response type", "enum": [ "NUMBER_CODE", "NO_RESPONSE", "PHONE_NUMBER", "QR_CODE" ], "example": "NUMBER_CODE", "type": "string" } }, "required": [ "authenticationInstruction", "responseType" ] }, "TwoFactorChoice": { "description": "A two factor code to be supplied to a collection. The collection will have status `TWO FACTOR PENDING` when a two factor code is expected from the user.", "properties": { "type": { "enum": [ "TWO_FACTOR_CHOICE" ], "example": "TWO_FACTOR_CHOICE", "type": "string" }, "value": { "description": "UUID of Selected Two factor method", "example": "2331690c-06ea-499b-a5b5-c719e253ce93", "type": "string" } }, "title": "TwoFactorChoice" }, "TwoFactorCode": { "description": "A two factor code to be supplied to a collection. The collection will have status `TWO FACTOR PENDING` when a two factor code is expected from the user.", "properties": { "type": { "enum": [ "TWO_FACTOR_CODE" ], "example": "TWO_FACTOR_CODE", "type": "string" }, "value": { "description": "Two factor code", "example": "A12345", "type": "string" } }, "title": "TwoFactorCode" }, "TwoFactorOption": { "description": "Available 2FA methods for this collection.", "properties": { "displayText": { "description": "text to display", "example": "Please supply the code sent to your iPhone 070******6", "type": "string" }, "type": { "description": "2FA type", "enum": [ "SMS", "APP", "APP_CODE", "EMAIL", "PROFILE" ], "example": "APP", "type": "string" }, "uuid": { "description": "uuid for this option", "example": "7fbc80f0-870b-4d94-8a31-baf683780b79", "type": "string" } } } }, "securitySchemes": { "authorization-token": { "description": "Your API key. Requests are only accepted from IP addresses on the client's allowlist, and with a registered client certificate when mTLS is enforced for the client.", "in": "header", "name": "authorization-token", "type": "apiKey" }, "client-id": { "description": "Your client ID, as used by the Prebuilt UI. Server-to-server integrations authenticate with authorization-token instead.", "in": "header", "name": "client-id", "type": "apiKey" }, "jwt-token": { "bearerFormat": "JWT", "description": "A user session token, sent as `Authorization: Bearer `.", "scheme": "bearer", "type": "http" } } }, "info": { "contact": { "email": "tech@insurely.com", "name": "Insurely", "url": "https://insurely.com" }, "description": "", "termsOfService": "https://www.insurely.com/sv/privacy-policy", "title": "Insurely API", "version": "2025-01-01" }, "openapi": "3.1.0", "paths": { "/companies/availability": { "get": { "description": "Obtain a full list of companies available for your client, together with their current status, availability (functional or not) and available login methods.", "operationId": "getCompaniesStatus", "parameters": [ { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "company-email": { "$ref": "#/components/examples/getCompaniesStatus-200-company-email" }, "company-functional": { "$ref": "#/components/examples/getCompaniesStatus-200-company-functional" }, "company-login-mobile": { "$ref": "#/components/examples/getCompaniesStatus-200-company-login-mobile" }, "company-login-region": { "$ref": "#/components/examples/getCompaniesStatus-200-company-login-region" } }, "schema": { "items": { "$ref": "#/components/schemas/CompanyAvailability" }, "type": "array" } } }, "description": "Successful request." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" } }, "security": [ { "authorization-token": [] }, { "client-id": [] } ], "summary": "Get status and availability", "tags": [ "Company" ] } }, "/insurance/collection": { "post": { "description": "Initiate an insurance data collection for a given individual based on the CollectionRequestInput with the specified login method.\n", "operationId": "initiateCollection", "parameters": [ { "in": "header", "name": "insurely-session-id", "required": false, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "examples": { "username-password": { "$ref": "#/components/examples/initiateCollection-request-username-password" }, "username-password-region": { "$ref": "#/components/examples/initiateCollection-request-username-password-region" } }, "schema": { "$ref": "#/components/schemas/CollectionRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "examples": { "started": { "$ref": "#/components/examples/initiateCollection-201-started" } }, "schema": { "$ref": "#/components/schemas/CollectionStatus" } } }, "description": "Data collection successfully initiated." }, "400": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-400" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Initiate collection", "tags": [ "Insurance Data Collection" ] } }, "/insurance/collection/{collectionId}": { "delete": { "description": "Deletes the collected data from an insurance collection.", "operationId": "deleteCollection", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "responses": { "204": { "description": "Collection successfully deleted." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" } }, "security": [ { "jwt-token": [] } ], "summary": "Delete collection", "tags": [ "Insurance Data Collection" ] } }, "/insurance/collection/{collectionId}/data": { "get": { "operationId": "getCollectionData", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "insurely-language", "required": false, "schema": { "enum": [ "sv", "en", "no", "da", "et", "fr", "de", "it", "lv", "lt", "ru" ], "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "insurance-animal-cat": { "$ref": "#/components/examples/getCollectionData-200-insurance-animal-cat" }, "insurance-generic": { "$ref": "#/components/examples/getCollectionData-200-insurance-generic" }, "insurance-house-villa": { "$ref": "#/components/examples/getCollectionData-200-insurance-house-villa" }, "insurance-person-accident": { "$ref": "#/components/examples/getCollectionData-200-insurance-person-accident" }, "insurance-person-health": { "$ref": "#/components/examples/getCollectionData-200-insurance-person-health" }, "insurance-vehicle-car": { "$ref": "#/components/examples/getCollectionData-200-insurance-vehicle-car" }, "insurance-vehicle-motorcycle": { "$ref": "#/components/examples/getCollectionData-200-insurance-vehicle-motorcycle" } }, "schema": { "items": { "$ref": "#/components/schemas/FullInsuranceWrapper" }, "type": "array" } } }, "description": "Insurance data successfully fetched." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Get collection data", "tags": [ "Insurance Data Collection" ] } }, "/insurance/collection/{collectionId}/policy/{policyId}/document/{documentId}": { "get": { "operationId": "getPolicyDocument", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "policyId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "documentId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "description": "Document successfully fetched." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Get collection policy document", "tags": [ "Insurance Data Collection" ] } }, "/insurance/collection/{collectionId}/skip": { "post": { "description": "Mark a collection as skipped by the user.", "operationId": "skipCollection", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "responses": { "201": { "description": "Successfully marked as skipped." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or disabled client." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The authenticated external user does not have access to the collection." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Collection not found for this client." }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too many requests. Please retry with backoff." } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Skip collection", "tags": [ "Insurance Data Collection" ] } }, "/insurance/collection/{collectionId}/status": { "get": { "description": "Returns the current status of an initiated collection of insurance data.", "operationId": "getCollectionStatus", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "completed": { "$ref": "#/components/examples/getCollectionStatus-200-completed" }, "incorrect-credentials": { "$ref": "#/components/examples/getCollectionStatus-200-incorrect-credentials" }, "waiting-2fa": { "$ref": "#/components/examples/getCollectionStatus-200-waiting-2fa" } }, "schema": { "$ref": "#/components/schemas/CollectionStatus" } } }, "description": "Status successfully fetched." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Get collection status", "tags": [ "Insurance Data Collection" ] } }, "/insurance/collection/{collectionId}/supplement-info": { "post": { "description": "Add supplemental information to a collection. This can be necessary if a collection requires 2 factor authentication. The collection will have the status 'TWO FACTOR PENDING' in this case.\n", "operationId": "addSupplementInformation", "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "type": "string" } }, { "description": "The API version to use, as YYYY-MM-DD. Must match the version of the endpoint you are targeting. A request without it, or with a version older than the client's minimum API version, is served by the client's minimum API version.", "example": "2025-01-01", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2025-01-01" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplementInformation" } } }, "required": true }, "responses": { "201": { "description": "Data collection successfully initiated." }, "400": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-400" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-429" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Too Many Requests" } }, "security": [ { "client-id": [] }, { "authorization-token": [] } ], "summary": "Add collection supplemental information", "tags": [ "Insurance Data Collection" ] } } }, "servers": [ { "description": "Production", "url": "https://api.insurely.com" }, { "description": "Test", "url": "https://api.test.insurely.com" } ], "tags": [ { "description": "Provides statuses of companies available for data collection", "name": "Company" }, { "description": "Initiate a collection of insurance data, see the status and get the data collected from the insurance company.\n", "name": "Insurance Data Collection" } ] }