This is a preview version of the API intended for early testing and integration. Preview versions are not stable and may include breaking changes before general availability.

Initiate collection

POSThttps://api.insurely.com/collections

Initiate a data collection. Calling this will trigger the selected login method.

Request

Header Parameters

insurely-session-idstring

Insurely-Versionstring

Specifies the API version to use. Must match the version of the endpoint you are targeting.

Possible Enum values are 2026-04-01.

Request Body

companystring

Company identifier.

loginMethodstring

The login method to use for authentication.

Possible Enum values are USERNAME_AND_PASSWORD, GERMAN_EID or AUTHENTICATION_APP_URL.

parametersArray<object>

Typed parameters describing how to authenticate, consent and scope the collection. Can be empty or null depending on the loginMethod provided.

One of these types:

Properties below are from the LoginMethodParameter subtype. View the full schema for full details.

Selects which login method the collector should trigger.

loginMethodstring

Identifier of the login method supported by the availability endpoint.

Possible Enum values are USERNAME_AND_PASSWORD, GERMAN_EID or AUTHENTICATION_APP_URL.

typestring

Possible Enum values are LOGIN_METHOD.

productTypeFilterArray<string>

Narrows the collection to a subset of the products this client is configured for. Omit the field to collect the full configured set. Each value is a product key of the form <market>.<category>.<product>. A three-segment key names a single product; a two-segment key names a whole category and collects every product the client is allowed in it. The market segment is always this market, insurance included. The accepted keys are enumerated on this field. That list is this market's vocabulary, not your entitlement: which of them your client may use depends on its configuration. Keys for the other domain, if your client collects both, are enumerated in that domain's spec. Rejected with 400: a key naming a category or product this market does not have; a named product the client is not configured for; or a filter that resolves to no products at all. An empty array is rejected for the same reason — omit the field instead. A category this market does have is never an error on its own. It contributes whatever the client is allowed in it, and nothing when that is empty, so a caller sending a fixed superset keeps working when the configuration changes underneath them. In France and Germany the configuration check is family-level rather than per product, because those markets record the product family rather than the product: a client configured for French pensions is accepted for any PER key.

Possible Enum values are de.investments, de.investments.custody_account, de.pension, de.pension.altersvorsorge, de.pension.altersvorsorge_depot, de.pension.bav, de.pension.other or de.pension.riester.

Responses

Data collection successfully initiated.

Body

companystring

Company that this collection is from

externalUserUuidstring

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}.

extraInformationCollectionStatusInformationMap

A key-value map containing potential extra information, depending on the company the collection is getting data from.

idstring

The collection ID of the request

pollingTimeoutstring[date-time]

The collection status must be polled before this timestamp. Failure to do so may result in the termination of the collection.

statusstring

Current status of the collection.

Possible Enum values are RUNNING, LOGIN, CUSTOMER_ENROLLMENT_CHECK, TWO_FACTOR_PENDING, TWO_FACTOR_METHOD_SELECTION_TIMEOUT, CONTACT_FORM_PENDING, COLLECTION_INPUT_PENDING, COLLECTION_INPUT_TIMEOUT, COLLECTING, COMPLETED, COMPLETED_PARTIAL, COMPLETED_EMPTY, FAILED, FAILED_PDF_PARSE, FAILED_PDF_USER_INPUT, AUTHENTICATION_TIMEOUT, WAITING_FOR_USER_ACTION, INCORRECT_CREDENTIALS, INCORRECT_TWO_FACTOR_CODE, AUTHENTICATION_CANCELLED, AUTHENTICATION_CONFLICT, ACCOUNT_TEMPORARILY_LOCKED, AUTHENTICATION_MISMATCH, KYC_FORM, CONTACT_FORM, CUSTOMER_ENROLLMENT_REQUIRED, THIRD_PARTY_ERROR, AUTHENTICATION_ERROR or LOGIN_METHOD_NOT_APPLICABLE.

cURL

curl https://api.insurely.com/collections \
  -H "authorization-token: <authorization-token>" \
  -H "Content-Type: application/json" \
  -d '{
  "company": "ee-ergo",
  "loginMethod": "USERNAME_AND_PASSWORD",
  "parameters": [],
  "productTypeFilter": [
    "de.pension",
    "de.pension.riester"
  ]
}' \
  -X POST