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.

CollectionStatusInformation

Possible extra information returned for a collection status

ACCESS_TOKENstring

Access token to call get-data. Returned when data collection is initiated by client-id.

AVAILABLE_TWO_FACTOR_METHODSArray<TwoFactorOption>

Available 2FA methods for this collection.

INSTRUCTIONSInstructionsRequestObject

Instructions used for SWEDISH_MOBILE_BANKID_SAME_DEVICE_CLIENT_SIDE_AUTHENTICATION login method.

QR_CODE_DATAstring

A base64 encoded QR-code.

REFERENCE_NUMBERstring

Reference number from login page to verify on other device.

REQUIRED_INPUT_TYPESArray<string>

Input that needs to be provided for the collection process to continue.

Type of input.

Possible Enum values are EMAIL.

TWO_FACTOR_AUTHENTICATION_INSTRUCTIONTwoFactorAuthenticationInstruction

Example

{
  "ACCESS_TOKEN": "-- Missing example --",
  "AVAILABLE_TWO_FACTOR_METHODS": [],
  "INSTRUCTIONS": {
    "request": {}
  },
  "QR_CODE_DATA": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==",
  "REFERENCE_NUMBER": "1234",
  "REQUIRED_INPUT_TYPES": "EMAIL",
  "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": {
    "authenticationInstruction": "Please authenticate with the following device: <name>'s IPHONE 13",
    "responseType": "NUMBER_CODE"
  }
}

{  "ACCESS_TOKEN": "-- Missing example --",  "AVAILABLE_TWO_FACTOR_METHODS": [],  "INSTRUCTIONS": {    "request": {}  },  "QR_CODE_DATA": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==",  "REFERENCE_NUMBER": "1234",  "REQUIRED_INPUT_TYPES": "EMAIL",  "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": {    "authenticationInstruction": "Please authenticate with the following device: <name>'s IPHONE 13",    "responseType": "NUMBER_CODE"  }}