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.

CollectionStatusResponse

companystring

Company identifier.

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

pollingIntervalinteger[int32]

The recommended interval in milliseconds at which to poll the /status endpoint for a collection. The endpoint can be polled less often, but latest by the value indicated by pollingTimeout to ensure that the collection is not terminated.

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, 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, 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",
  "extraInformation": {
    "SWEDISH_BANKID_QRCODE": "iVBORw0KGgoAA==",
    "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": "38bb848d-5a0d-4dec-977d-a8777f3637da"
  },
  "id": "22e633bc-427d-4f4a-87cf-cfaca04ef351",
  "pollingInterval": 1000,
  "pollingTimeout": "2024-09-26T12:59:10.545Z",
  "status": "RUNNING"
}

{  "company": "se-lansforsakringar",  "extraInformation": {    "SWEDISH_BANKID_QRCODE": "iVBORw0KGgoAA==",    "SWEDISH_MOBILE_BANKID_AUTOSTART_TOKEN": "38bb848d-5a0d-4dec-977d-a8777f3637da"  },  "id": "22e633bc-427d-4f4a-87cf-cfaca04ef351",  "pollingInterval": 1000,  "pollingTimeout": "2024-09-26T12:59:10.545Z",  "status": "RUNNING"}