You're reading version 2024-06-01, which is not the latest. The latest is 2026-04-01: open the 2026-04-01 introduction.

CollectionStatus

companystring

Company that this collection is from

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, TWO_FACTOR_PENDING, 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 or THIRD_PARTY_ERROR.

Example

{
  "company": "fr-info-retraite",
  "extraInformation": {
    "FRENCH_AUTHENTICATION_APP_QR_CODE": "iVBORw0KGgoAA==",
    "FRENCH_AUTHENTICATION_APP_URL": "https://app.trustmeid.io/transaction/0.1?transaction=bc453568-1e63-432c-9957-ae2fc6acb825&brand=FranceConnect"
  },
  "id": "22e633bc-427d-4f4a-87cf-cfaca04ef351",
  "pollingTimeout": "2024-09-26T12:59:10.545Z",
  "status": "RUNNING"
}

{  "company": "fr-info-retraite",  "extraInformation": {    "FRENCH_AUTHENTICATION_APP_QR_CODE": "iVBORw0KGgoAA==",    "FRENCH_AUTHENTICATION_APP_URL": "https://app.trustmeid.io/transaction/0.1?transaction=bc453568-1e63-432c-9957-ae2fc6acb825&brand=FranceConnect"  },  "id": "22e633bc-427d-4f4a-87cf-cfaca04ef351",  "pollingTimeout": "2024-09-26T12:59:10.545Z",  "status": "RUNNING"}