Skip to main content

ExtractionState

The extraction state capture the complete entity created by the ExtractionStarted and ExtractionFinished api calls. The extraction need not be finished to be returned in the case of extractions that are still in progress

statusExtractionStateEnum (string)required

Possible values: [SUCCESS, FAILURE]

typeExtractionTypeEnum (string)required

Possible values: [BANK_ACCOUNT, BANK_BALANCE, BANK_TRANSACTION, USER_INFO]

referenceIdstring

A possible reference id, often times an account external id

startedAtstring<date-time>

The time when the extraction was started

finishedAtstring<date-time>

The time when the extraction was finished

messagestring

Any comments as a result of the extraction

ExtractionState
{
"status": "SUCCESS",
"type": "BANK_ACCOUNT",
"referenceId": "string",
"startedAt": "2024-07-29T15:51:28.071Z",
"finishedAt": "2024-07-29T15:51:28.071Z",
"message": "string"
}