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 EmailParameter subtype. View the full schema for full details.

Input required for email-link authentication flows.

emailstring[email]

Email address that will receive the verification link.

Example

{
  "company": "se-nordea",
  "loginMethod": "EMAIL",
  "parameters": []
}

{  "company": "se-nordea",  "loginMethod": "EMAIL",  "parameters": []}