Objects
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.
CollectionStatus
companystring
Company that this collection is from
externalUserUuidstring
The UUID of the external user this collection belongs to, when it is linked to one (null otherwise). Can be used to build a Hub deep-link of the form /collections/user/{externalUserUuid}.
extraInformationCollectionStatusInformationMap
A key-value map containing potential extra information, depending on the company the collection is getting data from.
idstring
The collection ID of the request
pollingTimeoutstring[date-time]
The collection status must be polled before this timestamp. Failure to do so may result in the termination of the collection.
statusstring
Current status of the collection.
Possible Enum values are
RUNNING, LOGIN, CUSTOMER_ENROLLMENT_CHECK, TWO_FACTOR_PENDING, TWO_FACTOR_METHOD_SELECTION_TIMEOUT, CONTACT_FORM_PENDING, COLLECTION_INPUT_PENDING, COLLECTION_INPUT_TIMEOUT, COLLECTING, COMPLETED, COMPLETED_PARTIAL, COMPLETED_EMPTY, FAILED, FAILED_PDF_PARSE, FAILED_PDF_USER_INPUT, AUTHENTICATION_TIMEOUT, WAITING_FOR_USER_ACTION, INCORRECT_CREDENTIALS, INCORRECT_TWO_FACTOR_CODE, AUTHENTICATION_CANCELLED, AUTHENTICATION_CONFLICT, ACCOUNT_TEMPORARILY_LOCKED, AUTHENTICATION_MISMATCH, KYC_FORM, CONTACT_FORM, CUSTOMER_ENROLLMENT_REQUIRED, THIRD_PARTY_ERROR, AUTHENTICATION_ERROR or LOGIN_METHOD_NOT_APPLICABLE.Example
{ "company": "se-lansforsakringar", "externalUserUuid": "b3f1c2a4-8d6e-4f2b-9a1c-7e5d3b2a1f0e", "extraInformation": { "SWEDISH_BANKID_QRCODE": "iVBORw0KGgoAA==", "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": "38bb848d-5a0d-4dec-977d-a8777f3637da" }, "id": "22e633bc-427d-4f4a-87cf-cfaca04ef351", "pollingTimeout": "2024-09-26T12:59:10.545Z", "status": "RUNNING"}