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.

CollectionRequest

companystring

The name of the company to trigger the collection from

consentsArray<ConsentRequestInput>

A set of consents provided by the end user.

filterCollectionRequestFilter

inputobject

Key-value object specifying additional input required for the collection. What values should be included depends on context.Possible keys are SWEDISH_PERSONAL_NUMBER, NORWEGIAN_PERSONAL_NUMBER, NORWEGIAN_PHONE_NUMBER,USERNAME, PASSWORD, LASTNAME, ACCOUNT_OWNER_NAME.

loginMethodstring

Login method that will be used to authenticate the user. Available login methods for a company is specified in the /companies/availability response.

Possible Enum values are UK_DOB_USERNAME_PASSWORD, UK_LASTNAME_MEMBERSHIP_NUMBER or UK_USERNAME_POSTCODE.

Example

{
  "company": "se-lansforsakringar",
  "consents": [],
  "filter": {
    "rules": {}
  },
  "input": {
    "SWEDISH_PERSONAL_NUMBER": "192101010101"
  },
  "loginMethod": "SWEDISH_MOBILE_BANKID_ANY_DEVICE"
}

{  "company": "se-lansforsakringar",  "consents": [],  "filter": {    "rules": {}  },  "input": {    "SWEDISH_PERSONAL_NUMBER": "192101010101"  },  "loginMethod": "SWEDISH_MOBILE_BANKID_ANY_DEVICE"}