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.

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.

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 (e.g. ESTONIAN_SMART_ID).

Example

{
  "company": "ee-ergo",
  "loginMethod": "EMAIL",
  "parameters": []
}

{  "company": "ee-ergo",  "loginMethod": "EMAIL",  "parameters": []}