You're reading version 2024-06-01, which is not the latest. The latest is 2025-01-01: see this page in 2025-01-01.

EE · Insurance API · 2024-06-01

CompanyAvailability

additionalLoginInputsArray<AdditionalLoginInput>required

Additional input for login step.

availableCoverageScopesArray<InsuranceTypeAndSubtype>required

Set of available coverage types and subtypes for this company

companystringrequired

Name of the company.

companyAndLineOfBusinessesArray<string>required

Available company and line of business for insurance pdf upload.

Possible Enum values are 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 or FR_AG2R_LA_MONDIALE_HEALTH.

companyDisplayNamestringrequired

Company display name, for displaying to users.

companyGroupstring

The name of the group that a company or integration belongs to

companyLinksobject

Company-specific links such as contact forms or other external resources

consentRequirementsArray<ConsentRequirement>required

The set of consents required for initiating collections from this company.

functionalbooleanrequired

Whether or not it is possible to collect data from the company currently.

loginConfigCompanyLoginConfig

Configuration options for different login methods.

loginMethodsArray<string>required

Available login methods for the company.

Possible Enum values are 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, UK_DOB_USERNAME_PASSWORD, UK_LASTNAME_MEMBERSHIP_NUMBER, UK_USERNAME_POSTCODE, USERNAME_AND_PASSWORD, EMAIL, PDF_UPLOAD, GERMAN_EID, AUTHENTICATION_APP_URL, MANUAL_SELECT or API_KEY.

nonFunctionalLoginMethodsArray<string>required

Disabled login methods for the company.

notificationsobject

Company-specific notifications configuration

reasonstring

Reason for data collection being non-functional at present.

Possible Enum values are THIRD_PARTY_ERROR, THIRD_PARTY_UPDATE, INSURELY_ERROR, INSURELY_UPDATE or RECONSTRUCTION.

resetCredentialsobject

Reset links to reset credentials for the company.

statusstringrequired

Status indicating the quality of the data collection for this company. A company has status BETA until we can guarantee the data quality and stability of it, after which its status is set to OK. Once taken out of BETA it cannot be set to BETA again.

Possible Enum values are OK, BETA or NOT_IMPLEMENTED.

supportsPreheatingbooleanrequired

Whether the company supports starting a collection without user input. Requires input to be passed in at a later stage through the supplemental-info endpoint.

Example

{
  "additionalLoginInputs": [],
  "availableCoverageScopes": [
    {
      "insuranceSubType": "CAR_INSURANCE",
      "insuranceType": "VEHICLE_INSURANCE"
    }
  ],
  "company": "se-if",
  "companyAndLineOfBusinesses": [
    "SE_IF_VEHICLE"
  ],
  "companyDisplayName": "If",
  "companyGroup": "If",
  "companyLinks": {
    "contactFormLink": "https://example.com/contact"
  },
  "consentRequirements": [],
  "functional": false,
  "loginConfig": {
    "passwordFieldPlaceholder": "PASSWORD",
    "passwordLabel": "PASSWORD",
    "usernameFieldPlaceholder": "EMAIL",
    "usernameLabel": "EMAIL"
  },
  "loginMethods": [
    "SWEDISH_MOBILE_BANKID_SAME_DEVICE",
    "SWEDISH_MOBILE_BANKID_OTHER_DEVICE"
  ],
  "nonFunctionalLoginMethods": [
    "SWEDISH_MOBILE_BANKID_SAME_DEVICE",
    "SWEDISH_MOBILE_BANKID_OTHER_DEVICE"
  ],
  "notifications": {
    "LOADING_SCREEN": "SIGNIN_WARNING"
  },
  "reason": "THIRD_PARTY_ERROR",
  "resetCredentials": {
    "resetPasswordUrl": "https://insurely.com/forgot-password",
    "resetUsernameUrl": "https://insurely.com/forgot-username"
  },
  "status": "OK",
  "supportsPreheating": false
}

{  "additionalLoginInputs": [],  "availableCoverageScopes": [    {      "insuranceSubType": "CAR_INSURANCE",      "insuranceType": "VEHICLE_INSURANCE"    }  ],  "company": "se-if",  "companyAndLineOfBusinesses": [    "SE_IF_VEHICLE"  ],  "companyDisplayName": "If",  "companyGroup": "If",  "companyLinks": {    "contactFormLink": "https://example.com/contact"  },  "consentRequirements": [],  "functional": false,  "loginConfig": {    "passwordFieldPlaceholder": "PASSWORD",    "passwordLabel": "PASSWORD",    "usernameFieldPlaceholder": "EMAIL",    "usernameLabel": "EMAIL"  },  "loginMethods": [    "SWEDISH_MOBILE_BANKID_SAME_DEVICE",    "SWEDISH_MOBILE_BANKID_OTHER_DEVICE"  ],  "nonFunctionalLoginMethods": [    "SWEDISH_MOBILE_BANKID_SAME_DEVICE",    "SWEDISH_MOBILE_BANKID_OTHER_DEVICE"  ],  "notifications": {    "LOADING_SCREEN": "SIGNIN_WARNING"  },  "reason": "THIRD_PARTY_ERROR",  "resetCredentials": {    "resetPasswordUrl": "https://insurely.com/forgot-password",    "resetUsernameUrl": "https://insurely.com/forgot-username"  },  "status": "OK",  "supportsPreheating": false}