Objects

InitiateCollectionRequest

Future-proof request body that represents a collection as a set of typed parameters.

companystring

Company identifier.

loginMethodstring

The login method to use for authentication.

Possible Enum values are USERNAME_AND_PASSWORD, PDF_UPLOAD, AUTHENTICATION_APP_URL or MANUAL_SELECT.
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 EmailPasswordParameter subtype. View the full schema for full details.

Credentials for providers that require email plus password login.

emailstring[email]

Email address used as the username.

passwordstring

Account password.

typestring
Possible Enum values are EMAIL_PASSWORD.
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 fr.investments, fr.investments.compte_titres, fr.investments.life_insurance_bond, fr.investments.other, fr.investments.pea, fr.investments.pea_assurance, fr.investments.pea_jeune, fr.investments.pea_pme, fr.pension, fr.pension.article83, fr.pension.career_statement, fr.pension.madelin, fr.pension.other, fr.pension.perco, fr.pension.pereco, fr.pension.perin, fr.pension.perob, fr.pension.perp, fr.pension.prefon, fr.pension.public, fr.savings, fr.savings.cel, fr.savings.compte_sur_livret, fr.savings.ldds, fr.savings.lep, fr.savings.livret_a, fr.savings.livret_jeune, fr.savings.other or fr.savings.pel.
Example
{  "company": "ee-ergo",  "loginMethod": "USERNAME_AND_PASSWORD",  "parameters": [],  "productTypeFilter": [    "fr.pension",    "fr.savings.livret_a"  ]}