Objects
You're reading version 2025-01-01, which is not the latest. The latest is 2026-04-01: see this page in 2026-04-01.
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.
AUTHENTICATION_APP_URLstring
A url to trigger authentication apps.
QR_CODE_DATAstring
A base64 encoded QR-code.
AVAILABLE_TWO_FACTOR_METHODSArray<TwoFactorOption>
Available 2FA methods for this collection.
FRENCH_AUTHENTICATION_APP_URLstring
A url to trigger french authentication apps.
FRENCH_AUTHENTICATION_APP_QR_CODEstring
A base64 encoded QR-code.
RESEND_CODE_THRESHOLD_SECONDSinteger[int32]
Number of seconds to wait before showing the resend 2FA code option. Null if resend is not available.
TWO_FACTOR_AUTHENTICATION_INSTRUCTIONTwoFactorAuthenticationInstruction
REQUIRED_INPUT_TYPESArray<string>
Input that needs to be provided for the collection process to continue.
Type of input.
Possible Enum values are
EMAIL, LOGIN_METHOD, PASSWORD, POSTCODE, REGION or USERNAME.Example
{ "ACCESS_TOKEN": "-- Missing example --", "AUTHENTICATION_APP_URL": "https://banklogin.com/challenge?id=bc453568-1e63-432c-9957-ae2fc6acb826", "QR_CODE_DATA": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==", "AVAILABLE_TWO_FACTOR_METHODS": [], "FRENCH_AUTHENTICATION_APP_URL": "https://app.trustmeid.io/transaction/0.1?transaction=bc453568-1e63-432c-9957-ae2fc6acb825&brand=FranceConnect", "FRENCH_AUTHENTICATION_APP_QR_CODE": "R0lGODdhtAC0AIAAAAAAAP///ywAAALg==Lg==", "RESEND_CODE_THRESHOLD_SECONDS": "-- Missing example --", "TWO_FACTOR_AUTHENTICATION_INSTRUCTION": { "authenticationInstruction": "Please authenticate with the following device: <name>'s IPHONE 13", "responseType": "NUMBER_CODE" }, "REQUIRED_INPUT_TYPES": "EMAIL"}