Skip to main content

ExtractionFinished

This object is used to record an extraction run as completed for a particular type of information. It pairs with the ExtractionStarted object to mark an extraction as finished This api will throw an error if extraction started request was not recorded

finishedAtstring<date-time>

The time when the extraction was finished

referenceIdstring

A possible reference id, often times an account external id

typeExtractionTypeEnum (string)

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

statusExtractionStateEnum (string)

Possible values: [SUCCESS, FAILURE]

messagestring

Any comments as a result of the extraction

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