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 or MOBILE_PHONE_NUMBER.

SWEDISH_BANKID_QRCODEstring

A base64 encoded swedish BankId QR-code.

SWEDISH_MOBILE_BANKID_ANIMATED_QR_DATAstring

Used to generate an animated QR-code to authenticate users on other devices. The QR-code needs to be updated every second and is only applicable for companies that have the LoginMethod SWEDISH_MOBILE_BANKID_OTHER_DEVICE.

SWEDISH_MOBILE_BANKID_AUTOSTART_TOKENstring

Used to compile a QR image or an app-link.

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",
  "SWEDISH_BANKID_QRCODE": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==",
  "SWEDISH_MOBILE_BANKID_ANIMATED_QR_DATA": "bankid.67df3917-fa0d-44e5-b327-edcc928297f8.0.dc69358e712458a66a7525beef148ae8526b1c71610eff2c16cdffb4cdac9bf8",
  "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": "7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6",
  "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",  "SWEDISH_BANKID_QRCODE": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==",  "SWEDISH_MOBILE_BANKID_ANIMATED_QR_DATA": "bankid.67df3917-fa0d-44e5-b327-edcc928297f8.0.dc69358e712458a66a7525beef148ae8526b1c71610eff2c16cdffb4cdac9bf8",  "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": "7c40b5c9-fa74-49cf-b98c-bfe651f9a7c6",  "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": {    "authenticationInstruction": "Please authenticate with the following device: <name>'s IPHONE 13",    "responseType": "NUMBER_CODE"  }}