{ "components": { "examples": { "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 covered in a `villaInsurance`\n", "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" }, "AdditionalBuildingCottage": { "description": "An additional building on the same property as the main residence covered in a `cottageInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceCottage" }, "propertyName": "insurance" }, "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": "AdditionalBuildingCottage" }, "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" ] }, "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 `requiredInputTypes`, 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" } } }, "CollectionItem": { "properties": { "externalId": { "example": "def8d810-e60e-4922-a7ea-852648c2cf3c", "type": "string" }, "status": { "description": "Possible statuses for a policy being collected", "enum": [ "NOT_STARTED", "COMPLETED", "COLLECTING", "FAILED", "NOT_COLLECTED" ], "example": "NOT_STARTED", "type": "string" }, "subType": { "example": "condoInsuranceString", "type": "string" }, "type": { "example": "houseContentInsurance", "type": "string" } } }, "CollectionRequestFilter": { "properties": { "rules": { "items": { "$ref": "#/components/schemas/CollectionRequestFilterRule" }, "type": "array", "uniqueItems": true } } }, "CollectionRequestFilterRule": { "properties": { "field": { "enum": [ "registrationNo" ], "type": "string" }, "value": { "type": "string" } } }, "CollectionRequestV2": { "discriminator": { "propertyName": "api" }, "properties": { "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 insurance 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" }, "type": "object" }, "insuranceCompany": { "description": "The name of the insurance company to trigger the insurance collection from", "example": "se-lansforsakringar", "type": "string" }, "loginMethod": { "description": "Login method that will be used to authenticate the user. Available login methods for a company is specified in the `/insurance-company/status` response.", "enum": [ "DANISH_NEMID", "DANISH_MITID", "DANISH_MITID_SAME_DEVICE", "ESTONIAN_MOBILE_ID", "ESTONIAN_SMART_ID", "ESTONIAN_MOBILE_ID_USERNAME", "ESTONIAN_SMART_ID_USERNAME", "LATVIAN_MOBILE_EPARAKSTS", "LATVIAN_SMART_ID", "LATVIAN_MOBILE_EPARAKSTS_USERNAME", "LATVIAN_SMART_ID_USERNAME", "LITHUANIAN_SMART_ID", "LITHUANIAN_MOBILE_ID", "LITHUANIAN_SMART_ID_USERNAME", "LITHUANIAN_MOBILE_ID_USERNAME", "SMART_ID_SAME_DEVICE", "SMART_ID_OTHER_DEVICE", "SMART_ID_USERNAME_SAME_DEVICE", "SMART_ID_USERNAME_OTHER_DEVICE", "NORWEGIAN_BANKID_ON_MOBILE", "NORWEGIAN_BANKID_ON_MOBILE_FULL_PERSONAL_NUMBER", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_MOCK", "SWEDISH_MOBILE_BANKID_SAME_DEVICE", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION_MOCK", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_TEST", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_TEST", "SWEDISH_SECURITY_TOKEN", "UK_DOB_USERNAME_PASSWORD", "UK_LASTNAME_MEMBERSHIP_NUMBER", "UK_USERNAME_POSTCODE", "USERNAME_AND_PASSWORD", "EMAIL", "PDF_UPLOAD", "GERMAN_EID", "AUTHENTICATION_APP_URL", "MANUAL_SELECT", "API_KEY" ], "example": "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "type": "string" } } }, "CollectionStatus": { "discriminator": { "propertyName": "api" }, "properties": { "collectionItems": { "items": { "$ref": "#/components/schemas/CollectionItem" }, "type": "array" }, "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": { "AUTOSTART_TOKEN": "38bb848d-5a0d-4dec-977d-a8777f3637da", "SWEDISH_BANKID_QRCODE": "iVBORw0KGgoAA==" } }, "id": { "description": "The collection ID of the request", "example": "22e633bc-427d-4f4a-87cf-cfaca04ef351", "type": "string" }, "insuranceCompany": { "description": "Insurance company that this collection is from", "example": "se-lansforsakringar", "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 request. Possible values are: `RUNNING`, `LOGIN`,`CONTACT FORM PENDING`, `COLLECTING`, `COMPLETED`, `COMPLETED PARTIAL`, `COMPLETED EMPTY`, `FAILED`, `FAILED PDF PARSE`, `FAILED PDF USER INPUT` `WAITING FOR AUTHENTICATION`, `INCORRECT CREDENTIALS`, `KYC FORM`, `CUSTOMER ENROLLMENT REQUIRED`, `CONTACT FORM`, `AUTHENTICATION CONFLICT`, `AUTHENTICATION MISMATCH`, `TWO FACTOR PENDING`.", "example": "RUNNING", "type": "string" } }, "required": [ "id", "insuranceCompany", "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" }, "AUTOSTART_TOKEN": { "description": "A precompiled app-link with an embedded autostart token.", "example": "bankid:///?autostarttoken=7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6&redirect=bankid://bankid", "type": "string" }, "AVAILABLE_TWO_FACTOR_METHODS": { "description": "Available 2FA methods for this collection.", "items": { "$ref": "#/components/schemas/TwoFactorOption" }, "type": "array" }, "DANISH_NEM_ID_CARD_CODE_LOOKUP": { "description": "Nem ID number lookup for correct code from code card.", "example": "12345", "type": "string" }, "INSTRUCTIONS": { "$ref": "#/components/schemas/InstructionsRequestObject", "description": "Instructions used for SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION login method." }, "NORWEGIAN_BANKID_WORDS": { "description": "Two words for validating that the prompted session in app is the same.", "example": "SPINKEL BRIKKE", "type": "string" }, "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" }, "SWEDISH_BANKID_QRCODE": { "description": "A base64 encoded swedish BankId QR-code.", "example": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==", "type": "string" }, "SWEDISH_MOBILE_BANKID_ANIMATED_QR_DATA": { "description": "Used to generate an animated QR-code to authenticate users on other devices. The QR-code needs to be updated every second and is only applicable for companies that have the LoginMethod SWEDISH_MOBILE_BANKID_OTHER_DEVICE.", "example": "bankid.67df3917-fa0d-44e5-b327-edcc928297f8.0.dc69358e712458a66a7525beef148ae8526b1c71610eff2c16cdffb4cdac9bf8", "type": "string" }, "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": { "description": "Used to compile a QR image or an app-link.", "example": "7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6", "type": "string" }, "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": { "$ref": "#/components/schemas/TwoFactorAuthenticationInstruction" }, "requiredInputTypes": { "description": "Input that needs to be provided for the collection process to continue.", "example": "EMAIL", "items": { "description": "Type of input.", "enum": [ "EMAIL", "ESTONIAN_PERSONAL_NUMBER", "ESTONIAN_PHONE_NUMBER", "LASTNAME", "LATVIAN_PERSONAL_NUMBER", "LITHUANIAN_PERSONAL_NUMBER", "LITHUANIAN_PHONE_NUMBER", "LOGIN_METHOD", "MEMBERSHIP_NUMBER", "MOBILE_PHONE_NUMBER", "NORWEGIAN_BANKID_OTP", "NORWEGIAN_BANKID_PASSWORD", "NORWEGIAN_FULL_PERSONAL_NUMBER", "NORWEGIAN_PERSONAL_NUMBER", "NORWEGIAN_PHONE_NUMBER", "PASSWORD", "POSTCODE", "REGION", "SWEDISH_PERSONAL_NUMBER", "TRADE_UNION_MEMBERSHIP", "TWO_FACTOR_TOKEN", "UK_DATE_OF_BIRTH", "USERNAME" ], "example": "EMAIL", "type": "string" }, "type": "array" } }, "title": "CollectionStatusInformation" }, "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 }, "companyAndLineOfBusinesses": { "description": "Available company and line of business for insurance pdf upload", "example": "UK_AXA_HOME", "items": { "enum": [ "EE_SWEDBANK", "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", "LT_BALCIA_HOME", "LT_COMPENSA_HOME", "LT_ERGO_HOME", "LT_GJENSIDIGE_HOME", "LT_IF_HOME", "LT_LIETUVOS_DRAUDIMAS_HOME", "LT_SWEDBANK_HOME", "LV_BALCIA_HOME", "LV_BALTA_HOME", "LV_COMPENSA_HOME", "LV_ERGO_HOME", "LV_GJENSIDIGE_HOME", "LV_IF_HOME", "LV_SWEDBANK_HOME", "SE_IF_VEHICLE", "SE_FOLKSAM_VEHICLE", "SE_LANSFORSAKRINGAR_HOME", "SE_PAYDRIVE_VEHICLE", "SE_SVEDEA_VEHICLE", "SE_VOLVIA_VEHICLE", "SE_BLIWA_ACCIDENT", "UK_AXA_HOME", "UK_AXA_VEHICLE", "UK_HASTINGS_DIRECT_HOME", "UK_HASTINGS_DIRECT_VEHICLE", "UK_POLICYEXPERT_HOME", "UK_POLICYEXPERT_VEHICLE", "UK_POST_OFFICE_HOME", "UK_THE_AA_HOME", "UK_THE_AA_VEHICLE", "UK_URBAN_JUNGLE_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 }, "companyLinks": { "additionalProperties": { "type": "string" }, "description": "Company-specific links such as contact forms or other external resources", "example": "{'contactFormLink': 'https://example.com/contact-form'", "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" }, "insuranceCompany": { "description": "Insurance company name", "example": "uk-aviva", "minLength": 1, "type": "string" }, "insuranceCompanyDisplayName": { "description": "Insurance company display name, for displaying to users.", "example": "Aviva", "minLength": 1, "type": "string" }, "loginConfig": { "$ref": "#/components/schemas/CompanyLoginConfig", "description": "Configuration options for different login methods" }, "loginMethods": { "description": "Available login methods for insurance company", "example": "USERNAME_AND_PASSWORD", "items": { "enum": [ "DANISH_NEMID", "DANISH_MITID", "DANISH_MITID_SAME_DEVICE", "ESTONIAN_MOBILE_ID", "ESTONIAN_SMART_ID", "ESTONIAN_MOBILE_ID_USERNAME", "ESTONIAN_SMART_ID_USERNAME", "LATVIAN_MOBILE_EPARAKSTS", "LATVIAN_SMART_ID", "LATVIAN_MOBILE_EPARAKSTS_USERNAME", "LATVIAN_SMART_ID_USERNAME", "LITHUANIAN_SMART_ID", "LITHUANIAN_MOBILE_ID", "LITHUANIAN_SMART_ID_USERNAME", "LITHUANIAN_MOBILE_ID_USERNAME", "SMART_ID_SAME_DEVICE", "SMART_ID_OTHER_DEVICE", "SMART_ID_USERNAME_SAME_DEVICE", "SMART_ID_USERNAME_OTHER_DEVICE", "NORWEGIAN_BANKID_ON_MOBILE", "NORWEGIAN_BANKID_ON_MOBILE_FULL_PERSONAL_NUMBER", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_MOCK", "SWEDISH_MOBILE_BANKID_SAME_DEVICE", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION_MOCK", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_TEST", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_TEST", "SWEDISH_SECURITY_TOKEN", "UK_DOB_USERNAME_PASSWORD", "UK_LASTNAME_MEMBERSHIP_NUMBER", "UK_USERNAME_POSTCODE", "USERNAME_AND_PASSWORD", "EMAIL", "PDF_UPLOAD", "GERMAN_EID", "AUTHENTICATION_APP_URL", "MANUAL_SELECT", "API_KEY" ], "type": "string" }, "type": "array", "uniqueItems": true }, "nonFunctionalLoginMethods": { "description": "Disabled login methods for insurance company", "example": "USERNAME_AND_PASSWORD", "items": { "enum": [ "DANISH_NEMID", "DANISH_MITID", "DANISH_MITID_SAME_DEVICE", "ESTONIAN_MOBILE_ID", "ESTONIAN_SMART_ID", "ESTONIAN_MOBILE_ID_USERNAME", "ESTONIAN_SMART_ID_USERNAME", "LATVIAN_MOBILE_EPARAKSTS", "LATVIAN_SMART_ID", "LATVIAN_MOBILE_EPARAKSTS_USERNAME", "LATVIAN_SMART_ID_USERNAME", "LITHUANIAN_SMART_ID", "LITHUANIAN_MOBILE_ID", "LITHUANIAN_SMART_ID_USERNAME", "LITHUANIAN_MOBILE_ID_USERNAME", "SMART_ID_SAME_DEVICE", "SMART_ID_OTHER_DEVICE", "SMART_ID_USERNAME_SAME_DEVICE", "SMART_ID_USERNAME_OTHER_DEVICE", "NORWEGIAN_BANKID_ON_MOBILE", "NORWEGIAN_BANKID_ON_MOBILE_FULL_PERSONAL_NUMBER", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_MOCK", "SWEDISH_MOBILE_BANKID_SAME_DEVICE", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION_MOCK", "SWEDISH_MOBILE_BANKID_OTHER_DEVICE_TEST", "SWEDISH_MOBILE_BANKID_SAME_DEVICE_TEST", "SWEDISH_SECURITY_TOKEN", "UK_DOB_USERNAME_PASSWORD", "UK_LASTNAME_MEMBERSHIP_NUMBER", "UK_USERNAME_POSTCODE", "USERNAME_AND_PASSWORD", "EMAIL", "PDF_UPLOAD", "GERMAN_EID", "AUTHENTICATION_APP_URL", "MANUAL_SELECT", "API_KEY" ], "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 insurance 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", "companyAndLineOfBusinesses", "consentRequirements", "functional", "insuranceCompany", "insuranceCompanyDisplayName", "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" } } }, "CoreInsuranceCar": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceCar" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "core" } }, "type": "object" } ], "description": "Car insurances are of insurance type `vehicleInsurance` with the subtype `carInsurance`", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceCar" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "CoreInsuranceCar", "x-tag": "Insurance Type" }, "CoreInsuranceHome": { "allOf": [ { "$ref": "#/components/schemas/InsuranceHome" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "core" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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" } }, "type": "object" } ], "description": "Home insurances are of insurance type `houseContentInsurance` and subtype `condoInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceHome" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "CoreInsuranceOtherVehicle": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceOtherVehicle" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "core" } }, "type": "object" } ], "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", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceOtherVehicle" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "CoreInsuranceOtherVehicle", "x-tag": "Insurance Type" }, "CoreInsuranceVilla": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceVilla" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "core" }, "additionalBuildings": { "description": "Information about any additional buildings on the property", "items": { "$ref": "#/components/schemas/AdditionalBuilding" }, "type": "array" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "hasBasement": { "description": "Whether the residence has a basement.", "example": true, "type": "boolean" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "insuranceObjectPropertyCode": { "description": "Property code of the insured object", "example": "Blueberry 1:10", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "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" }, "numberOfToilets": { "description": "Number of toilets in the residence.", "example": 4, "format": "int32", "type": "integer" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "purchaseYear": { "description": "The year the residence was purchased.", "example": "1995", "type": "string" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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" } }, "type": "object" } ], "description": "Villa insurances are of insurance type `houseContentInsurance` and subtype `villaInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceVilla" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "CoverageCompany": { "enum": [ "se-agria", "se-akademikerforsakring", "se-atlantica", "se-demo", "se-demo-two", "se-demo-four", "se-bliwa", "se-dina", "se-dunstan", "se-euroaccident", "se-folksam", "se-gjensidige", "se-gofido", "se-hedvig", "se-ica", "se-if", "se-lansforsakringar", "se-lassie", "se-manypets", "se-moderna", "se-movestic", "se-skandia", "se-spp", "se-svedea", "se-trekronor", "se-trygg-hansa", "se-volvia", "se-paydrive", "se-sveland", "se-leaky", "se-watercircles", "se-sensor", "se-soderberg-partners", "se-villaagarna", "se-lf-alvsborg", "se-lf-bergslagen", "se-lf-blekinge", "se-lf-dalarna", "se-lf-goteborg-bohuslan", "se-lf-goinge-kristianstad", "se-lf-gotland", "se-lf-gavleborg", "se-lf-halland", "se-lf-jamtland", "se-lf-jonkoping", "se-lf-norrbotten", "se-lf-ostgota", "se-lf-kalmar", "se-lf-kronoberg", "se-lf-stockholm", "se-lf-sormland", "se-lf-skane", "se-lf-skaraborg", "se-lf-uppsala", "se-lf-varmland", "se-lf-vasterbotten", "se-lf-vasternorrland", "se-if-volkswagen", "se-if-subaru", "se-if-skoda", "se-if-seat", "se-if-renault", "se-if-porsche", "se-if-polestar", "se-if-nissan", "se-if-mg", "se-if-mercedes", "se-if-kia", "se-if-isuzu", "se-if-ford", "se-if-dacia", "se-if-cupra", "se-if-audi", "no-demo", "no-eika", "no-frende", "no-gjensidige", "no-if", "no-sparebank1", "no-tryg", "dk-alka", "dk-almbrand", "dk-bauta", "dk-codan", "dk-demo", "dk-fdm", "dk-gfforsikring", "dk-gjensidige", "dk-ida", "dk-if", "dk-lb", "dk-lbforsikringpfa", "dk-runa", "dk-tjm", "dk-topdanmark", "dk-tryg", "uk-aa", "uk-admiral", "uk-animalfriends", "uk-axa", "uk-axa-vehicle", "uk-aviva", "uk-barclays", "uk-manypets", "uk-churchill", "uk-demo", "uk-natwest", "uk-directline", "uk-halifax", "uk-hastings-direct", "uk-john-lewis-home", "uk-lv", "uk-morethan-home", "uk-onecall", "uk-petplan", "uk-policyexpert-home", "uk-policyexpert-vehicle", "uk-postoffice", "uk-privilege", "uk-rac", "uk-saga", "uk-sainsburys", "uk-sainsburys-pet", "uk-sheilaswheels", "uk-sosure", "uk-swinton", "uk-tesco", "uk-urbanjungle", "uk-waggel", "ee-balcia", "ee-bta", "ee-demo", "ee-demo-two", "ee-elama", "ee-ergo", "ee-gjensidige", "ee-if", "ee-pzu", "ee-salva", "ee-seesam", "ee-swedbank", "ee-lhv", "es-mapfre", "es-demo", "fr-abeille", "fr-acheel", "fr-allianz", "fr-amundi", "fr-animauxsante", "fr-assur-opoil", "fr-axa", "fr-bred", "fr-bred-wealth", "fr-bulle-bleue", "fr-bnp-paribas", "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-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-santevet", "fr-lolivier", "fr-caisse-depargne", "fr-caisse-depargne-wealth", "fr-banque-populaire", "fr-banque-populaire-wealth", "fr-mobilize", "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-cnp", "fr-allianz-wealth", "fr-groupama-wealth", "fr-n26", "fr-axa-wealth", "fr-fortuneo", "fr-credit-mutuel-wealth", "fr-ag2r-la-mondiale-wealth", "fr-societe-generale-insurance", "lv-balcia", "lv-balta", "lv-ban", "lv-bta", "lv-compensa", "lv-demo", "lv-ergo", "lv-gjensidige", "lv-if", "lv-luminor", "lv-seb", "lv-swedbank", "lt-demo", "lt-demo-two", "lt-gjensidige", "lt-swedbank", "lt-ergo", "lt-balcia", "lt-compensa", "lt-if", "lt-lietuvos-draudimas" ], "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" }, "CoveragePolicyData": { "properties": { "insuredMovablesAmount": { "description": "Limit for the movable objects in the home", "example": 1500000, "format": "int32", "type": "integer" }, "label": { "description": "Used to indicate if the policy is a if branded insurance", "example": "branded-insurance", "type": "string" }, "otherInsuranceHolder": { "description": "If the holder of the insurance policy is not the current user", "type": "boolean" }, "ownershipStatus": { "description": "Status of the ownership, Only used in the french market", "enum": [ "OWNER", "TENANT", "SECONDARY_TENANT", "UNKNOWN" ], "type": "string" }, "region": { "description": "Region if the company has regional companies within it", "example": "LF Stockholm", "type": "string" }, "residentialStatus": { "description": "Status of the residency, Only used in the french market", "enum": [ "PRIMARY_RESIDENCE", "SECONDARY_RESIDENCE", "RENTAL_RESIDENCE", "UNKNOWN" ], "type": "string" }, "vehicleBrand": { "description": "Vehicle brand if it's a branded car insurance", "type": "string" }, "versionId": { "description": "Id of the version for the coverage requested", "examples": [ "2023-02-10", "A300/2022" ], "type": "string" } } }, "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" } } }, "EstonianInsurance": { "discriminator": { "mapping": { "hidden": "#/components/schemas/EstonianInsurance" }, "propertyName": "insurance" }, "properties": { "@market": { "$ref": "#/components/schemas/Market" }, "insuranceCompanyRegistrationCode": { "description": "Insurance company registration code.", "example": "12345678", "type": "string" } }, "title": "EstonianInsurance", "x-markets": { "ee": true } }, "EstonianInsuranceCar": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/EstonianInsurance" }, { "$ref": "#/components/schemas/InsuranceCar" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "ee" }, "insuranceBeneficiaryCode": { "description": "Personal or company code of the insurance beneficiary", "example": "01234567890", "type": "string" }, "insuranceBeneficiaryName": { "description": "Name of the insurance beneficiary", "example": "John Doe", "type": "string" }, "insuranceCompanyRegistrationCode": { "description": "Insurance company registration code.", "example": "12345678", "type": "string" }, "insuranceHolderCompanyCode": { "description": "Company code of the insurance holder", "example": "12345678", "type": "string" }, "insuranceHolderPersonalCode": { "description": "Personal code of the insurance holder", "example": "1234567890", "type": "string" }, "insuranceInsuredPersonCode": { "description": "Code of the insured person or company", "example": "90123456789", "type": "string" }, "insuranceInsuredPersonName": { "description": "Name of the insured person or company", "example": "Johny Doe", "type": "string" } }, "type": "object" } ], "description": "Estonian car insurances are of insurance type `vehicleInsurance` with the subtype `carInsurance`, containing additional fields relevant for the Estonian market\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceCar" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "EstonianInsuranceCar", "x-tag": "Insurance Type" }, "FarmProperty": { "description": "An additional property included in the `farmInsurance`.", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceFarm" }, "propertyName": "insurance" }, "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", "discriminator": { "mapping": { "parent": "#/components/schemas/FrenchInsuranceVehicle" }, "propertyName": "insurance" }, "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "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" }, "FrenchInsurance": { "discriminator": { "mapping": { "hidden": "#/components/schemas/FrenchInsurance" }, "propertyName": "insurance" }, "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "claims": { "$ref": "#/components/schemas/Claims", "description": "Enabled by feature flag" }, "insuranceHolderDateOfBirth": { "description": "The birthdate of the insurance holder", "example": "1999-12-31", "type": "string" }, "insuranceHolderEmail": { "description": "The email of the insurance holder.", "example": "example@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The biological sex of the insurance holder.", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "FEMALE", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder.", "example": "Software Engineer", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder.", "example": "+33 93 233 8246", "type": "string" }, "policyHolder": { "$ref": "#/components/schemas/PolicyHolder", "description": "Information about the policy holder" }, "termsAndConditionsVersion": { "$ref": "#/components/schemas/TermsAndConditionsVersion" } }, "title": "FrenchInsurance", "x-markets": { "fr": true } }, "FrenchInsuranceCar": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/FrenchInsurance" }, { "$ref": "#/components/schemas/FrenchInsuranceVehicle" }, { "$ref": "#/components/schemas/InsuranceCar" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "bonusMalus": { "$ref": "#/components/schemas/BonusMalus" }, "claims": { "$ref": "#/components/schemas/Claims", "description": "Enabled by feature flag" }, "insuranceHolderDateOfBirth": { "description": "The birthdate of the insurance holder", "example": "1999-12-31", "type": "string" }, "insuranceHolderEmail": { "description": "The email of the insurance holder.", "example": "example@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The biological sex of the insurance holder.", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "FEMALE", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder.", "example": "Software Engineer", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder.", "example": "+33 93 233 8246", "type": "string" }, "parking": { "$ref": "#/components/schemas/FrenchParkingLocation", "description": "Details about the parking location of the vehicle covered by the insurance policy" }, "policyHolder": { "$ref": "#/components/schemas/FrenchPolicyHolder", "description": "Information about the policy holder" }, "primaryDriver": { "$ref": "#/components/schemas/FrenchDriverInformation", "description": "The primary driver registered on the insurance policy" }, "secondaryDrivers": { "description": "Any additional drivers registered on the insurance policy", "items": { "$ref": "#/components/schemas/FrenchDriverInformation" }, "type": "array", "uniqueItems": true }, "termsAndConditionsVersion": { "$ref": "#/components/schemas/TermsAndConditionsVersion" }, "usagePurposes": { "description": "Which purposes the vehicle is covered for", "items": { "description": "A purpose for which the vehicle is used", "enum": [ "PRIVATE", "COMMUTING", "WORK" ], "example": "COMMUTING", "type": "string" }, "type": "array", "uniqueItems": true } }, "type": "object" } ], "description": "French car insurances are of insurance type `vehicleInsurance` with the subtype `carInsurance`, containing additional fields relevant for the French market\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceCar" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "FrenchInsuranceCar", "x-tag": "Insurance Type" }, "FrenchInsuranceHome": { "allOf": [ { "$ref": "#/components/schemas/InsuranceHome" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "additionalAmenities": { "description": "Which amenities are available in the home.", "example": "FIREPLACE", "items": { "enum": [ "FIREPLACE", "POOL", "GARDEN" ], "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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "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" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birthdate of the insurance holder", "example": "1999-12-31", "type": "string" }, "insuranceHolderEmail": { "description": "The email of the insurance holder.", "example": "example@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The biological sex of the insurance holder.", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "FEMALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder.", "example": "Software Engineer", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder.", "example": "+33 93 233 8246", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "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" }, "insuredValuablesAmount": { "description": "Maximum compensation for valuable property.", "example": 85000, "format": "double", "type": "number" }, "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" }, "numberOfRooms": { "description": "The number of rooms in the home.", "example": 4, "format": "int32", "type": "integer" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "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" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "policyHolder": { "$ref": "#/components/schemas/FrenchPolicyHolder", "description": "Information about the policy holder" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "professionalUsage": { "description": "Whether the property is used for business purposes.", "example": false, "type": "boolean" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "type": "string" }, "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" } }, "type": "object" } ], "description": "French home insurances are of insurance type `houseContentInsurance` and subtype `condoInsurance`, containing additional fields relevant for the French market\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceHome" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "FrenchInsuranceHome", "x-tag": "Insurance Type" }, "FrenchInsuranceHouseContent": { "description": "Schema implemented by all French contents insurance objects (see extended sections).\n", "discriminator": { "mapping": { "condoInsurance": "#/components/schemas/FrenchInsuranceHome", "parent": "#/components/schemas/InsuranceHouseContent", "villaInsurance": "#/components/schemas/FrenchInsuranceVilla" }, "propertyName": "insuranceSubType" }, "properties": { "additionalAmenities": { "description": "Which amenities are available in the home.", "example": "FIREPLACE", "items": { "description": "Which amenities are available in the home.", "enum": [ "FIREPLACE", "POOL", "GARDEN" ], "example": "FIREPLACE", "type": "string" }, "type": "array", "uniqueItems": true }, "insurancePreviouslyRefused": { "description": "Whether insurance coverage has been refused for this person.", "example": false, "type": "boolean" }, "insuredValuablesAmount": { "description": "Maximum compensation for valuable property.", "example": 85000, "format": "double", "type": "number" }, "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" }, "numberOfRooms": { "description": "The number of rooms in the home.", "example": 4, "format": "int32", "type": "integer" }, "outbuildingsTotalArea": { "$ref": "#/components/schemas/FrenchOutbuildingsTotalArea" }, "ownershipStatus": { "description": "Whether the home is owned by the insurance holder.", "enum": [ "OWNER", "TENANT", "SECONDARY_TENANT", "UNKNOWN" ], "example": "OWNER", "type": "string" }, "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" } }, "title": "FrenchInsuranceVehicle", "x-markets": { "fr": true } }, "FrenchInsuranceVehicle": { "description": "Schema implemented by all French vehicle insurance objects (see extended sections).\n", "discriminator": { "mapping": { "carInsurance": "#/components/schemas/FrenchInsuranceCar", "parent": "#/components/schemas/InsuranceVehicle" }, "propertyName": "insuranceSubType" }, "properties": { "parking": { "$ref": "#/components/schemas/FrenchParkingLocation", "description": "Details about the parking location of the vehicle covered by the insurance policy" }, "primaryDriver": { "$ref": "#/components/schemas/FrenchDriverInformation", "description": "The primary driver registered on the insurance policy" }, "secondaryDrivers": { "description": "Any additional drivers registered on the insurance policy", "items": { "$ref": "#/components/schemas/FrenchDriverInformation" }, "type": "array", "uniqueItems": true }, "usagePurposes": { "description": "Which purposes the vehicle is covered for", "items": { "description": "A purpose for which the vehicle is used", "enum": [ "PRIVATE", "COMMUTING", "WORK" ], "example": "COMMUTING", "type": "string" }, "type": "array", "uniqueItems": true }, "vehicleOwnership": { "$ref": "#/components/schemas/FrenchVehicleOwnership", "description": "The ownership form of the vehicle" } }, "title": "FrenchInsuranceVehicle", "x-markets": { "fr": true } }, "FrenchInsuranceVilla": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/FrenchInsurance" }, { "$ref": "#/components/schemas/FrenchInsuranceHouseContent" }, { "$ref": "#/components/schemas/InsuranceVilla" }, { "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "additionalAmenities": { "description": "Which amenities are available in the home.", "example": "FIREPLACE", "items": { "enum": [ "FIREPLACE", "POOL", "GARDEN" ], "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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birthdate of the insurance holder", "example": "1999-12-31", "type": "string" }, "insuranceHolderEmail": { "description": "The email of the insurance holder.", "example": "example@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The biological sex of the insurance holder.", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "FEMALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder.", "example": "Software Engineer", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder.", "example": "+33 93 233 8246", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "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" }, "insuredValuablesAmount": { "description": "Maximum compensation for valuable property.", "example": 85000, "format": "double", "type": "number" }, "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" }, "numberOfRooms": { "description": "The number of rooms in the home.", "example": 4, "format": "int32", "type": "integer" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "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" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "policyHolder": { "$ref": "#/components/schemas/FrenchPolicyHolder", "description": "Information about the policy holder" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "professionalUsage": { "description": "Whether the property is used for business purposes.", "example": false, "type": "boolean" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "type": "string" }, "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" } }, "type": "object" } ], "description": "Villa insurances are of insurance type `houseContentInsurance` and subtype `villaInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceVilla" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "FrenchInsuranceVilla", "x-tag": "Insurance Type" }, "FrenchOutbuildingsArea": { "allOf": [ { "$ref": "#/components/schemas/FrenchOutbuildingsTotalArea" }, { "properties": { "area": { "description": "The area of the building", "example": 10, "format": "int32", "type": "integer" } }, "type": "object" } ], "description": "The total surface area of outbuildings." }, "FrenchOutbuildingsAreaRange": { "allOf": [ { "$ref": "#/components/schemas/FrenchOutbuildingsTotalArea" }, { "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" } }, "type": "object" } ], "description": "The total surface area range of outbuildings." }, "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", "discriminator": { "mapping": { "parent": "#/components/schemas/FrenchInsuranceVehicle" }, "propertyName": "insurance" }, "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "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" }, "FrenchParkingLocation": { "description": "Details about the parking location of a vehicle insured in France", "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "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" }, "FrenchPolicyHolder": { "description": "A French policy holder", "discriminator": { "mapping": { "parent": "#/components/schemas/FrenchInsurance" }, "propertyName": "insurance" }, "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "name": { "$ref": "#/components/schemas/FrenchPolicyHolderName" } }, "title": "FrenchPolicyHolder" }, "FrenchPolicyHolderName": { "description": "Policy holder name for french market", "discriminator": { "mapping": { "parent": "#/components/schemas/FrenchInsurance" }, "propertyName": "insurance" }, "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "firstName": { "description": "The policy holder's first name", "example": "Cornélie", "type": "string" }, "fullName": { "description": "The policy holder's full name", "example": "Cornélie Boivin", "type": "string" }, "lastName": { "description": "The policy holder's last name", "example": "Boivin", "type": "string" } }, "title": "FrenchPolicyHolderName" }, "FrenchVehicleOwnership": { "description": "Ownership details of a French vehicle", "discriminator": { "mapping": { "parent": "#/components/schemas/FrenchInsuranceVehicle" }, "propertyName": "insurance" }, "example": "OWNED", "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "fr" }, "status": { "description": "The form of ownership for a French vehicle", "enum": [ "OWNED", "LEASING", "UNKNOWN" ], "example": "OWNED", "title": "FrenchVehicleOwnershipStatus", "type": "string" } }, "title": "FrenchVehicleOwnership" }, "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" }, "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" }, "insurance": { "$ref": "#/components/schemas/InsuranceWrapper", "description": "The basic insurance data collected from the insurance company" }, "parameters": { "description": "The parameter mapping of the insurance coverage", "items": { "$ref": "#/components/schemas/InsuranceParameterValue" }, "type": "array" }, "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" } }, "title": "Full Insurance Wrapper" }, "GetParametersRequest": { "discriminator": { "propertyName": "api" }, "properties": { "addOns": { "items": { "type": "string" }, "type": "array", "uniqueItems": true, "writeOnly": true }, "coveragePolicyData": { "$ref": "#/components/schemas/CoveragePolicyData", "writeOnly": true }, "getParameterPolicyData": { "$ref": "#/components/schemas/CoveragePolicyData" }, "insuranceCompany": { "$ref": "#/components/schemas/CoverageCompany", "description": "Insurance company that this collection is from", "example": "se-lansforsakringar" }, "insuranceName": { "description": "Name of the insurance to get parameters for", "example": "Halvförsäkring", "minLength": 1, "type": "string" }, "insuranceSubType": { "description": "Insurance sub type to get parameters for", "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": "carInsurance", "type": "string" }, "insuranceType": { "description": "Insurance type to get parameters for", "enum": [ "vehicleInsurance", "houseContentInsurance", "personInsurance", "animalInsurance", "groupInsurance", "generalInsurance", "incomeInsurance" ], "example": "vehicleInsurance", "type": "string" } }, "required": [ "insuranceCompany", "insuranceName", "insuranceSubType", "insuranceType" ] }, "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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ] }, "InsuranceAccident": { "description": "Accident insurances are of insurance type `personInsurance` and subtype `accidentInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsurancePerson" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "insuredAmountBaseEconomicalDisability": { "description": "The base amount for economical disability compensation. The compensation for specific injuries are based on this amount.\n", "example": 700000, "format": "int32", "type": "integer" }, "insuredAmountBaseMedicalDisability": { "description": "The base amount for medical disability compensation. The compensation for specific injuries are based on this amount.\n", "example": 700000, "format": "int32", "type": "integer" }, "insuredAmountLife": { "description": "The compensation if the insurance holder is to decease.", "example": 100000, "format": "int32", "type": "integer" }, "insuredAmountMaxMedicalDisability": { "description": "The maximum compensation for a medical disability. A multiple of the base amount.\n", "example": 2100000, "format": "int32", "type": "integer" }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "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", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceWrapper" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/Insurance" } ], "properties": { "animalBreed": { "description": "Breed of the animal", "example": "Golden retriever", "type": "string" }, "animalGender": { "description": "Gender of the animal", "enum": [ "MALE", "FEMALE", "CASTRATED_MALE", "CASTRATED_FEMALE", "UNKNOWN" ], "example": "MALE", "type": "string" }, "animalName": { "description": "Name of the animal", "example": "Pelle", "type": "string" }, "animalPurchasePrice": { "description": "Animal purchase annualPremium", "example": 12000, "format": "int32", "type": "integer" }, "chipNumber": { "description": "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": "Animal's date of birth ", "example": "2018-12-01", "type": "string" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insurance": { "description": "Basic insurance information" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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" }, "veterinaryCareAmount": { "description": "Maximum reimbursed veterinary care amount per insurance period", "example": 60000, "format": "int32", "type": "integer" }, "veterinaryCareAmountRemaining": { "description": "Remaining veterinary care amount for the insurance period", "example": 43100, "format": "int32", "type": "integer" }, "veterinaryCareCovered": { "description": "Veterinary care covered percentage for the insurance period", "example": 80, "format": "int32", "type": "integer" } }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceCar": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceVehicle" }, { "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", "no", "se", "uk", "core" ], "example": "core", "title": "@market" }, "coverage": { "description": "The vehicle insurance coverage", "enum": [ "UNDEFINED", "FULL_WITH_CHASSI", "FULL_WITHOUT_CHASSI", "TRAFFIC", "NOT_IN_TRAFFIC", "COMPREHENSIVE", "CASCO", "MTPL" ], "example": "FULL_WITH_CHASSI", "type": "string" }, "insuranceLevel": { "description": "The scope of the insurance according to konsumenternas. PLUS means more coverage, BASE is base coverage and UNDEFINED is when it's unknown.\n", "enum": [ "BASE", "PLUS", "UNDEFINED" ], "example": "BASE", "type": "string" }, "maxMileage": { "description": "Max mileage per year that the insurance covers in km.", "example": 10000, "format": "int32", "type": "integer" }, "usedForWork": { "description": "The insurance covers the vehicle if it is used for work.", "example": false, "type": "boolean" }, "youngDriver": { "description": "Insurance policy explicitly mention a young driver as listed driver of the car (mentioned during the subscription process).", "example": true, "type": "boolean" }, "youngDriverAge": { "description": "The maximum age to be considered a young driver.", "example": 23, "format": "int32", "type": "integer" } }, "type": "object" } ], "description": "Car insurances are of insurance type `vehicleInsurance` with the subtype `carInsurance`.\n", "discriminator": { "mapping": { "core": "#/components/schemas/CoreInsuranceCar", "ee": "#/components/schemas/EstonianInsuranceCar", "fr": "#/components/schemas/FrenchInsuranceCar", "parent": "#/components/schemas/InsuranceVehicle", "se": "#/components/schemas/SwedishInsuranceCar" }, "propertyName": "@market" }, "oneOf": [ { "$ref": "#/components/schemas/CoreInsuranceCar" }, { "$ref": "#/components/schemas/FrenchInsuranceCar" }, { "$ref": "#/components/schemas/SwedishInsuranceCar" }, { "$ref": "#/components/schemas/EstonianInsuranceCar" } ], "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceCar" }, "InsuranceChild": { "description": "Child insurances are of insurance type `personInsurance` and subtype `childInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsurancePerson" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "insuredAmountBaseEconomicalDisability": { "description": "The base amount for economical disability compensation. The compensation for specific injuries are based on this amount.\n", "example": 700000, "format": "int32", "type": "integer" }, "insuredAmountBaseMedicalDisability": { "description": "The base amount for medical disability compensation. The compensation for specific injuries are based on this amount.\n", "example": 700000, "format": "int32", "type": "integer" }, "insuredAmountLife": { "description": "The compensation if the child is to decease.", "example": 100000, "format": "int32", "type": "integer" }, "insuredAmountMaxMedicalDisability": { "description": "The maximum compensation for a medical disability. A multiple of the base amount.\n", "example": 2100000, "format": "int32", "type": "integer" }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceCompany": { "enum": [ "se-agria", "se-alandsbanken-psd2", "se-alecta", "se-amf", "se-atlantica", "se-avanza", "se-avida", "se-borgo", "se-demo", "se-demo-psd2", "se-demo-two", "se-demo-four", "se-demo-client-authentication", "se-bank-norwegian", "se-bliwa", "se-bluestep-bank", "se-collector", "se-danske-bank", "se-danske-bank-psd2", "se-dina", "se-ekobanken-psd2", "se-euroaccident", "se-folksam", "se-futur", "se-gjensidige", "se-gofido", "se-handelsbanken", "se-handelsbanken-psd2", "se-hedvig", "se-ica", "se-ica-bank", "se-ica-bank-psd2", "se-if", "se-if-mercedes", "se-ikano-bank", "se-ikano-bank-psd2", "se-jak-medlemsbank-psd2", "se-klarna-psd2", "se-kpa", "se-lan-och-spar-bank", "se-lan-och-spar-bank-psd2", "se-lansforsakringar", "se-lansforsakringar-psd2", "se-lassie", "se-lea-bank", "se-levler", "se-lysa", "se-manypets", "se-marginalen-bank", "se-marginalen-bank-psd2", "se-medmera-bank", "se-moderna", "se-montrose", "se-morrow", "se-movestic", "se-nordax-bank", "se-nordea", "se-nordea-psd2", "se-nordnet", "se-okq8-bank-psd2", "se-opti", "se-remember", "se-resurs-bank", "se-resurs-bank-psd2", "se-rocker-psd2", "se-savr", "se-sbab", "se-sbab-psd2", "se-seb", "se-seb-bank", "se-seb-psd2", "se-skandia", "se-skandia-psd2", "se-sparbanken-syd-psd2", "se-spp", "se-spv", "se-svea", "se-svea-psd2", "se-svedea", "se-trekronor", "se-trygg-hansa", "se-volvia", "se-paydrive", "se-pp-pension", "se-santander", "se-sveland", "se-svenska-fribrevsbolaget", "se-swedbank", "se-swedbank-insurance", "se-swedbank-psd2", "se-leaky", "se-watercircles", "se-kapan", "se-sensor", "se-soderberg-partners", "se-ziklo-psd2", "no-demo", "no-eika", "no-frende", "no-gjensidige", "no-if", "no-sparebank1", "no-tryg", "dk-alka", "dk-almbrand", "dk-arbejdernes-landsbank", "dk-bauta", "dk-codan", "dk-danske-bank", "dk-demo", "dk-fdm", "dk-gfforsikring", "dk-gjensidige", "dk-ida", "dk-if", "dk-jyske-bank", "dk-landbobank", "dk-lb", "dk-lbforsikringpfa", "dk-nordea", "dk-nordnet", "dk-nykredit", "dk-runa", "dk-saxo-bank", "dk-spar-nord", "dk-sydbank", "dk-tjm", "dk-topdanmark", "dk-tryg", "dk-vestjysk-bank", "uk-aa", "uk-admiral", "uk-aegon", "uk-aj-bell", "uk-animalfriends", "uk-aviva", "uk-axa", "uk-axa-vehicle", "uk-bank-of-scotland", "uk-barclays", "uk-chase", "uk-churchill", "uk-demo", "uk-directline", "uk-etoro", "uk-fidelity", "uk-freetrade", "uk-halifax", "uk-halifax-investments", "uk-hargreaves-lansdown", "uk-hastings-direct", "uk-hsbc", "uk-interactive-investor", "uk-john-lewis-home", "uk-legal-and-general", "uk-lloyds", "uk-lv", "uk-manypets", "uk-moneybox", "uk-moneyfarm", "uk-monzo", "uk-morethan-home", "uk-nationwide", "uk-natwest", "uk-nest", "uk-onecall", "uk-peoples-pension", "uk-petplan", "uk-policyexpert-home", "uk-policyexpert-vehicle", "uk-postoffice", "uk-privilege", "uk-rac", "uk-revolut", "uk-saga", "uk-sainsburys", "uk-sainsburys-pet", "uk-santander", "uk-scottish-widows", "uk-sheilaswheels", "uk-sosure", "uk-standard-life", "uk-starling", "uk-swinton", "uk-tesco", "uk-trading212", "uk-urbanjungle", "uk-vanguard", "uk-waggel", "ee-balcia", "ee-bta", "ee-demo", "ee-demo-two", "ee-elama", "ee-ergo", "ee-gjensidige", "ee-if", "ee-pzu", "ee-salva", "ee-seesam", "ee-swedbank", "ee-lhv", "es-bbva", "es-banco-sabadell", "es-bankinter", "es-caixabank", "es-demo", "es-ibercaja", "es-indexa-capital", "es-kutxabank", "es-mapfre", "es-myinvestor", "es-revolut", "es-santander", "es-trade-republic", "es-unicaja", "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", "lv-balcia", "lv-balta", "lv-ban", "lv-bta", "lv-compensa", "lv-demo", "lv-ergo", "lv-gjensidige", "lv-if", "lv-luminor", "lv-seb", "lv-swedbank", "lt-demo", "lt-demo-two", "lt-gjensidige", "lt-swedbank", "lt-ergo", "lt-balcia", "lt-compensa", "lt-if", "lt-lietuvos-draudimas", "de-demo", "de-sparkasse-berliner", "de-sparkasse-haspa", "de-volksbanken-berliner", "de-volksbanken-hamburger", "de-deutschebank", "de-ing", "de-dkb", "de-comdirect", "de-commerzbank", "de-trade-republic", "de-n26", "de-revolut", "de-consorsbank", "de-scalable-capital", "de-rv-versicherung", "de-union-investment", "de-ergo", "de-dws", "de-allianz", "de-axa", "de-rentenuebersicht", "it-demo", "it-etoro", "it-revolut", "it-scalable-capital", "it-trade-republic", "at-demo", "at-revolut", "xx-loadtest-scrape", "xx-loadtest-api", "xx-docs" ], "type": "string" }, "InsuranceCottage": { "description": "Cottage insurances are of insurance type `houseContentInsurance` and subtype `cottageInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceWrapper" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/Insurance" } ], "properties": { "@market": { "$ref": "#/components/schemas/Market", "example": "core" }, "additionalBuildings": { "items": { "$ref": "#/components/schemas/AdditionalBuildingCottage" }, "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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "hasBasement": { "description": "Whether the residence has a basement.", "example": true, "type": "boolean" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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": { "description": "Maximum compensation for movable 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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "purchaseYear": { "description": "The year the residence was purchased.", "example": "1995", "type": "string" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceFarm": { "description": "Farm insurances are of insurance type `houseContentInsurance` and subtype `farmInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceWrapper" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/Insurance" } ], "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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "farmProperties": { "items": { "$ref": "#/components/schemas/FarmProperty" }, "type": "array" }, "hasBasement": { "description": "Whether the residence has a basement.", "example": true, "type": "boolean" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "purchaseYear": { "description": "The year the residence was purchased.", "example": "1995", "type": "string" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceGeneral": { "description": "General insurances are of insurance type `generalInsurance` and subtype `genericInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceWrapper" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insurance": { "description": "Basic insurance information" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceHome": { "allOf": [ { "$ref": "#/components/schemas/InsuranceHouseContent" }, { "properties": { "connectedAlarmDiscount": { "description": "Discount related to having a connected alarm system.", "example": true, "type": "boolean" }, "securityDoorGridDiscount": { "description": "Discount related to having an approved security door or grid.", "example": true, "type": "boolean" } }, "type": "object" } ], "description": "Home insurances are of insurance type `houseContentInsurance` and subtype `condoInsurance`\n(or 'contentsInsurance' for dk)\n", "discriminator": { "mapping": { "core": "#/components/schemas/CoreInsuranceHome", "fr": "#/components/schemas/FrenchInsuranceHome", "parent": "#/components/schemas/InsuranceWrapper", "se": "#/components/schemas/SwedishInsuranceHome" }, "propertyName": "@market" }, "oneOf": [ { "$ref": "#/components/schemas/CoreInsuranceHome" }, { "$ref": "#/components/schemas/FrenchInsuranceHome" }, { "$ref": "#/components/schemas/SwedishInsuranceHome" } ], "title": "InsuranceHome" }, "InsuranceHouseContent": { "allOf": [ { "$ref": "#/components/schemas/Insurance" } ], "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": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/InsuranceHome" }, { "$ref": "#/components/schemas/InsuranceVilla" }, { "$ref": "#/components/schemas/InsuranceCottage" } ], "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", "no", "se", "uk", "core" ], "example": "core", "title": "@market" }, "insuranceSubType": { "type": "string" } }, "required": [ "externalId", "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", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceWrapper" }, "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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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": { "description": "Selected insurance amount which a lump sum payout is based on. Only applicable for certain income insurance types\n", "example": 360000, "format": "int32", "type": "integer" }, "insuredMonthlyAmount": { "description": "Monthly payment amount.", "example": 16000, "format": "int32", "type": "integer" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "qualifyingPeriodDays": { "description": "Number of working days before qualified for payouts", "example": 180, "format": "int32", "type": "integer" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "Income insurance", "x-tag": "Insurance Type" }, "InsuranceLife": { "description": "Life insurances are of insurance type `personInsurance` and subtype `lifeInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsurancePerson" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "insuredAmountLife": { "description": "Insured amount in the local currency", "example": 1500000, "format": "int32", "type": "integer" }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsuranceOtherVehicle": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceVehicle" }, { "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", "no", "se", "uk", "core" ], "example": "core", "title": "@market" } }, "type": "object" } ], "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", "discriminator": { "mapping": { "core": "#/components/schemas/CoreInsuranceOtherVehicle" }, "propertyName": "@market" }, "oneOf": [ { "$ref": "#/components/schemas/CoreInsuranceOtherVehicle" } ], "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceOtherVehicle" }, "InsuranceParameter": { "description": "Insurance parameter describes one insurance element for a specific insurance sub-type.", "discriminator": { "propertyName": "insurance-parameters" }, "properties": { "parameterDescription": { "description": "Description of the parameter in the local language.", "example": "Försäkringen täcker stöld eller tillgrepp av den försäkrade bilen. Du kan i vissa fall även få ersättning för skador på bilen som uppkommit i samband med stöld eller inbrottsförsök.", "type": "string" }, "parameterDisplayName": { "description": "Display name for the parameter presented in the local language.", "example": "Stöld", "type": "string" }, "parameterGroup": { "type": "string" }, "parameterGroupOrder": { "format": "int32", "type": "integer" }, "parameterName": { "description": "The name of the parameter as returned for a specific insurance. In english.", "example": "theft", "type": "string" } }, "title": "Insurance Parameter" }, "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": { "description": "Person insurances are of insurance type `personInsurance` with the following possible subtypes:\n* `childInsurance`\n* `lifeInsurance`\n* `accidentInsurance`\n* `pregnancyInsurance`\n* `healthInsurance`\n", "discriminator": { "mapping": { "accidentInsurance": "#/components/schemas/InsuranceAccident", "childInsurance": "#/components/schemas/InsuranceChild", "lifeInsurance": "#/components/schemas/InsuranceLife", "pregnancyInsurance": "#/components/schemas/InsurancePregnancy" }, "propertyName": "insuranceSubType" }, "oneOf": [ { "$ref": "#/components/schemas/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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "InsurancePregnancy": { "description": "Pregnancy insurances are of insurance type `personInsurance` and subtype `pregnancyInsurance`\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsurancePerson" }, "propertyName": "insurance" }, "oneOf": [ { "$ref": "#/components/schemas/InsurancePerson" } ], "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "insuredAmountBaseMedicalDisability": { "description": "The base amount for medical disability compensation. The compensation for specific injuries are based on this amount.\n", "example": 700000, "format": "int32", "type": "integer" }, "insuredPersonName": { "description": "Name of the person covered by the insurance. Can differ from the insurance holder name.", "example": "Karl Karlsson", "type": "string" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "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": { "allOf": [ { "$ref": "#/components/schemas/Insurance" } ], "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", "parent": "#/components/schemas/InsuranceWrapper" }, "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" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "registrationNo": { "description": "Registration number for vehicle", "example": "ABC000", "type": "string" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "InsuranceVehicle" }, "InsuranceVilla": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceHouseContent" }, { "properties": { "ancillaryArea": { "description": "Ancillary area in square meters rounded to nearest integer.", "example": 72, "format": "int32", "type": "integer" }, "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" } }, "type": "object" } ], "description": "Villa insurances are of insurance type `houseContentInsurance` and subtype `villaInsurance`\n", "discriminator": { "mapping": { "core": "#/components/schemas/CoreInsuranceVilla", "fr": "#/components/schemas/FrenchInsuranceVilla", "parent": "#/components/schemas/InsuranceWrapper", "se": "#/components/schemas/SwedishInsuranceVilla" }, "propertyName": "@market" }, "oneOf": [ { "$ref": "#/components/schemas/CoreInsuranceVilla" }, { "$ref": "#/components/schemas/FrenchInsuranceVilla" }, { "$ref": "#/components/schemas/SwedishInsuranceVilla" } ], "title": "InsuranceVilla" }, "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/InsuranceAccident" }, { "$ref": "#/components/schemas/InsuranceChild" }, { "$ref": "#/components/schemas/InsurancePregnancy" }, { "$ref": "#/components/schemas/InsuranceLife" }, { "$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", "ESTONIAN_PERSONAL_NUMBER", "ESTONIAN_PHONE_NUMBER", "LASTNAME", "LATVIAN_PERSONAL_NUMBER", "LITHUANIAN_PERSONAL_NUMBER", "LITHUANIAN_PHONE_NUMBER", "LOGIN_METHOD", "MEMBERSHIP_NUMBER", "MOBILE_PHONE_NUMBER", "NORWEGIAN_BANKID_OTP", "NORWEGIAN_BANKID_PASSWORD", "NORWEGIAN_FULL_PERSONAL_NUMBER", "NORWEGIAN_PERSONAL_NUMBER", "NORWEGIAN_PHONE_NUMBER", "PASSWORD", "POSTCODE", "REGION", "SWEDISH_PERSONAL_NUMBER", "TRADE_UNION_MEMBERSHIP", "TWO_FACTOR_TOKEN", "UK_DATE_OF_BIRTH", "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": [ "dk", "ee", "lv", "lt", "fr", "no", "se", "uk", "es", "core" ], "example": "core", "title": "Market", "type": "string" }, "MonetaryAmount": { "description": "A monetary amount.", "properties": { "currencyCode": { "description": "The ISO-4217 currency code of this monetary amount.", "enum": [ "DKK", "EUR", "GBP", "NOK", "SEK" ], "example": "EUR", "type": "string" }, "minorUnitAmount": { "description": "The amount in minor units, as defined in ISO-4217. E.g. the minor unit of EUR is 1 cent.", "example": 24999, "format": "int64", "type": "integer" } }, "title": "Monetary Amount" }, "PolicyHolder": { "description": "Policy holder information", "discriminator": { "mapping": { "fr": "#/components/schemas/FrenchPolicyHolder", "parent": "#/components/schemas/FrenchInsurance" }, "propertyName": "@market" }, "oneOf": [ { "$ref": "#/components/schemas/FrenchPolicyHolder" } ], "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", "no", "se", "uk", "core" ], "example": "core", "title": "@market" } }, "title": "PolicyHolder" }, "Premium": { "description": "A premium including the amount, frequency and taxation type.", "properties": { "amount": { "$ref": "#/components/schemas/MonetaryAmount", "description": "The premium amount." }, "frequency": { "description": "The frequency with which this premium is based on.", "enum": [ "YEARLY_PREMIUM_FREQUENCY", "UNKNOWN_PREMIUM_FREQUENCY" ], "example": "YEARLY_PREMIUM_FREQUENCY", "type": "string" }, "taxation": { "description": "Whether taxation is a part of the premium or not.", "enum": [ "INCLUSIVE_TAXATION", "EXCLUSIVE_TAXATION", "UNKNOWN_TAXATION" ], "example": "INCLUSIVE_TAXATION", "type": "string" } } }, "Request": { "properties": { "body": { "description": "If the method is POST, body to be included in the POST request.", "example": { "username": "19900101-1234" } }, "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": { "type": "string" }, "description": "The keys and values of the response headers", "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": "-", "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/ResponseObject" }, { "$ref": "#/components/schemas/TwoFactorChoice" }, { "$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" }, "SupplementInformationRequest": { "description": "Supplemental information to be added to a running collection.", "discriminator": { "propertyName": "api" }, "properties": { "collectionId": { "description": "The collection ID to append supplemental information to", "example": "22e633bc-427d-4f4a-87cf-cfaca04ef351", "minLength": 1, "type": "string" }, "supplementalInformation": { "$ref": "#/components/schemas/SupplementInformation", "description": "The supplemental information to provide." } }, "required": [ "collectionId" ], "title": "SupplementInformationRequest" }, "SwedishInsuranceCar": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceCar" } ], "description": "Car insurances are of insurance type `vehicleInsurance` with the subtype `carInsurance`", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceCar" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "CoreInsuranceCar", "x-tag": "Insurance Type" }, "SwedishInsuranceHome": { "allOf": [ { "$ref": "#/components/schemas/InsuranceHome" }, { "properties": { "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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" } }, "type": "object" } ], "description": "Swedish home insurances are of insurance type `houseContentInsurance` and subtype `condoInsurance`, containing additional fields relevant for the Swedish market\n", "discriminator": { "mapping": { "parent": "#/components/schemas/InsuranceHome" }, "propertyName": "insurance" }, "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "title": "SwedishInsuranceHome", "x-tag": "Insurance Type" }, "SwedishInsuranceVilla": { "allOf": [ { "$ref": "#/components/schemas/Insurance" }, { "$ref": "#/components/schemas/InsuranceVilla" }, { "properties": { "additionalBuildings": { "description": "Information about any additional buildings on the property", "items": { "$ref": "#/components/schemas/AdditionalBuilding" }, "type": "array" }, "coming": { "description": "If the insurance startDate is in the future given the current date of the data collection\n", "example": false, "type": "boolean" }, "discountAmount": { "description": "Yearly discount amount in local currency", "example": 143, "format": "int32", "type": "integer" }, "discountPercentage": { "description": "The discount percentage, represented as a string containing a number between 0 and 100. Null if not available.", "example": "10", "type": "string" }, "endDate": { "description": "End date for the insurance", "example": "2023-12-31", "type": "string" }, "externalId": { "description": "Unique identifier for a specific insurance within a collection.", "example": "a8a2d600-d314-4ef3-ade1-611c3b596296", "type": "string" }, "hasBasement": { "description": "Whether the residence has a basement.", "example": true, "type": "boolean" }, "insuranceCompany": { "$ref": "#/components/schemas/InsuranceCompany", "description": "Insurance company name", "example": "se-insurance-company" }, "insuranceHolderCity": { "description": "City of residence of the insurance holder", "example": "Stockholm", "type": "string" }, "insuranceHolderDateOfBirth": { "description": "The birth date of the insurance holder", "example": "1990-01-24", "type": "string" }, "insuranceHolderEmail": { "description": "The email address of the insurance holder - disabled by default\n", "example": "abc@insurely.com", "type": "string" }, "insuranceHolderGender": { "description": "The gender of the insurance holder", "enum": [ "MALE", "FEMALE", "OTHER", "UNKNOWN" ], "example": "MALE", "type": "string" }, "insuranceHolderName": { "description": "Name of the insurance holder", "example": "Förnamn Efternamn", "type": "string" }, "insuranceHolderOccupation": { "description": "The occupation of the insurance holder", "example": "Teacher", "type": "string" }, "insuranceHolderPhoneNumber": { "description": "The phone number of the insurance holder - disabled by default\n", "example": "+01234567890", "type": "string" }, "insuranceHolderPostalCode": { "description": "Postal code of the insurance holder", "example": "12345", "type": "string" }, "insuranceHolderStreetAddress": { "description": "Street address of the insurance holder", "example": "Blåbärsvägen 1", "type": "string" }, "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" }, "insuranceObjectPropertyCode": { "description": "Property code of the insured object", "example": "Blueberry 1:10", "type": "string" }, "insuranceSubType": { "description": "Subtype of insurance", "example": "condoInsurance", "type": "string" }, "insuranceType": { "description": "Type of insurance", "example": "houseContentInsurance", "type": "string" }, "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" }, "numberOfToilets": { "description": "Number of toilets in the residence.", "example": 4, "format": "int32", "type": "integer" }, "otherInsuranceHolder": { "description": "If the insurance holder is someone other than the person who is collecting the data", "example": false, "type": "boolean" }, "paymentMethod": { "description": "Method of payment", "enum": [ "UNDEFINED", "AUTOGIRO", "PAPER_INVOICE", "ELECTRONIC_INVOICE", "GENERIC_INVOICE", "ONE_TIME_PAYMENT", "EMPLOYER_PAID", "CREDIT_CARD" ], "example": "GENERIC_INVOICE", "type": "string" }, "premium": { "$ref": "#/components/schemas/Premium", "description": "The premium the insurance holder has to pay." }, "premiumAmountYearRounded": { "description": "Yearly premium after discounts rounded to nearest integer", "example": 2355, "format": "int32", "type": "integer" }, "premiumFrequency": { "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" }, "purchaseYear": { "description": "The year the residence was purchased.", "example": "1995", "type": "string" }, "renewalDate": { "description": "Renewal date for the insurance", "example": "2020-01-01", "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" } }, "type": "object" } ], "description": "Villa insurances are of insurance type `houseContentInsurance` and subtype `villaInsurance`\n", "required": [ "externalId", "insuranceCompany", "insuranceSubType", "insuranceType" ], "x-tag": "Insurance Type" }, "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": { "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" } } }, "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" ], "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": "2023-03-15" }, "openapi": "3.1.0", "paths": { "/insurance-collection/collect-info": { "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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionRequestV2" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "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": "Invalid additional input." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or the token specified is not allowed to collect information from the specified insurance company.\n" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Initiate collection", "tags": [ "Insurance Data Collection" ] } }, "/insurance-collection/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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "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": "Authentication failed: 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." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "No collection with that ID exists for this client, the collection has expired or there was no data to fetch." } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Get collection policy document", "tags": [ "Insurance Data Collection" ] } }, "/insurance-collection/get-data/{collectionId}": { "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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "Authentication failed: 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." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "No collection with that ID exists for this client, the collection has expired or there was no data to fetch.\n" } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Get collection data", "tags": [ "Insurance Data Collection" ] } }, "/insurance-collection/get-parameters": { "post": { "description": "Get a list of included parameters for a specified insurance at a specific insurance company. Typical use case is wanting to compare insurance content between a collected insurance and an alternative.\n", "operationId": "getParameters", "parameters": [ { "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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetParametersRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/InsuranceParameterValue" }, "type": "array" } } }, "description": "Insurance parameters successfully fetched." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or the token specified is not allowed to collect information from the specified insurance company.\n" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." } }, "security": [ { "client-id": [] }, { "authorization-token": [] } ], "summary": "Get insurance company parameters", "tags": [ "Insurance Data Collection" ] } }, "/insurance-collection/parameters/{country}": { "get": { "description": "Get all available parameters including description for a specific country. Country is specified according to ISO 3166-1 alpha-2. Typical use case is wanting to compare insurance content between a collected insurance and an alternative or display additional information to your users.\n", "operationId": "getAllParameters", "parameters": [ { "in": "path", "name": "country", "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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": { "$ref": "#/components/schemas/InsuranceParameter" }, "type": "array" }, "type": "object" } } }, "description": "Insurance parameters successfully fetched." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or the token specified is not allowed to collect information from the specified insurance company.\n" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." } }, "security": [ { "client-id": [] }, { "authorization-token": [] } ], "summary": "Get parameters by insuranceSubType ", "tags": [ "Insurance Data Collection" ] } }, "/insurance-collection/status/{collectionId}": { "get": { "description": "Returns the current status of an initiated collection of pension data. The value of status will be one of the following: `RUNNING`, `LOGIN`, `COLLECTING`, `COMPLETED PARTIAL`, `COMPLETED`, `COMPLETED EMPTY`, `TWO FACTOR PENDING`, `WAITING FOR AUTHENTICATION`, `FAILED`, `FAILED PDF PARSE`, `FAILED PDF USER INPUT`, `KYC FORM`, `CONTACT FORM`, `CUSTOMER ENROLLMENT REQUIRED`, `AUTHENTICATION CANCELLED`, `AUTHENTICATION CONFLICT`, `AUTHENTICATION MISMATCH`, `INCORRECT CREDENTIALS`. The returned object will potentially have an imageValue and a token. The token is a mobile BankID autostart token to be sent to the user, and the image is a base64 encoded QR-code to be scanned by the user in their mobile BankID app. This will need to be rendered by the API user.\n", "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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "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": "Authentication failed: 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." }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." }, "404": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-404" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "No collection with that ID exists for this client, or the collection has expired." } }, "security": [ { "client-id": [] }, { "authorization-token": [] }, { "jwt-token": [] } ], "summary": "Get collection status", "tags": [ "Insurance Data Collection" ] } }, "/insurance-collection/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": [ { "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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplementInformationRequest" } } }, "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": "Invalid personal number specified." }, "401": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-401" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Invalid authorization token or the token specified is not allowed to collect information from the specified insurance company.\n" }, "403": { "content": { "application/json": { "examples": { "error": { "$ref": "#/components/examples/standard-error-403" } }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "The client is not allowed to use this endpoint or resource." } }, "security": [ { "client-id": [] }, { "authorization-token": [] } ], "summary": "Add collection supplemental information", "tags": [ "Insurance Data Collection" ] } }, "/insurance-company/status": { "get": { "description": "Obtain a full list of insurance 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": "2023-03-15", "in": "header", "name": "Insurely-Version", "required": true, "schema": { "enum": [ "2023-03-15" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CompanyAvailability" }, "type": "array" } } }, "description": "Successful request." } }, "security": [ { "authorization-token": [] }, { "client-id": [] } ], "summary": "Get status and availability", "tags": [ "Insurance Company" ] } } }, "servers": [ { "description": "Production", "url": "https://api.insurely.com" }, { "description": "Test", "url": "https://api.test.insurely.com" } ], "tags": [ { "description": "Provides statuses of insurance companies for data collection", "name": "Insurance 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" } ] }