FR · Wealth API · 2026-04-01

Get status and availability

GEThttps://api.insurely.com/companies/availability

Obtain a full list of companies available for your client, together with their current status, availability (functional or not) and available login methods.

Request

Header Parameters

Insurely-Versionstringrequired

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.

Possible Enum values are 2026-04-01, 2025-01-01 or 2024-06-01.

Responses

Successful request.

Body

additionalLoginInputsArray<AdditionalLoginInput>required

Additional input for login step.

availableCoverageScopesArray<InsuranceTypeAndSubtype>required

Set of available coverage types and subtypes for this company

collectionMethodstringrequired

The method used to collect data from this company. PSD2 indicates bank API collection, LEFI indicates registry-based collection, and STANDARD indicates the normal Insurely data collection flow.

Possible Enum values are PSD2, LEFI or STANDARD.

companystringrequired

Name of the company.

companyAndLineOfBusinessesArray<string>required

Available company and line of business for insurance pdf upload.

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 USERNAME_AND_PASSWORD, AUTHENTICATION_APP_URL, FRENCH_IMPOTS_GOUV, FRENCH_AMELI or FRENCH_FRANCE_IDENTITE.

nonFunctionalLoginMethodsArray<string>required

Disabled login methods for the company.

Possible Enum values are USERNAME_AND_PASSWORD, AUTHENTICATION_APP_URL, FRENCH_IMPOTS_GOUV, FRENCH_AMELI or FRENCH_FRANCE_IDENTITE.

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. A company may also be reported with status DEGRADED_PERFORMANCE when it is experiencing intermittent issues, usually due to errors at the data source. When status is DEGRADED_PERFORMANCE collections can still be attempted but may fail or return incomplete data.

Possible Enum values are OK, BETA, NOT_IMPLEMENTED or DEGRADED_PERFORMANCE.

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.

cURL

curl https://api.insurely.com/companies/availability \
  -H "authorization-token: <authorization-token>" \
  -H "Insurely-Version: 2026-04-01"

RESPONSE 200

[
  {
    "additionalLoginInputs": [],
    "availableCoverageScopes": [],
    "collectionMethod": "STANDARD",
    "company": "fr-bourso-bank",
    "companyAndLineOfBusinesses": [],
    "companyDisplayName": "BoursoBank",
    "consentRequirements": [],
    "functional": true,
    "loginMethods": [
      "USERNAME_AND_PASSWORD"
    ],
    "nonFunctionalLoginMethods": [],
    "status": "OK",
    "supportsPreheating": false
  },
  {
    "additionalLoginInputs": [],
    "availableCoverageScopes": [],
    "collectionMethod": "STANDARD",
    "company": "fr-demo-info-retraite",
    "companyAndLineOfBusinesses": [],
    "companyDisplayName": "Demo Info Retraite",
    "consentRequirements": [],
    "functional": true,
    "loginMethods": [
      "FRENCH_IMPOTS_GOUV"
    ],
    "nonFunctionalLoginMethods": [],
    "status": "BETA",
    "supportsPreheating": false
  }
]