Skip to content

Cleaning Up Data

When using the Document Reader SDK Web Service with applied Complete Server-Side Verification, persistent transaction-related data can be accumulated over time.

This can lead to the growth of persistent storage, potentially consuming significant resources.

Document Reader SDK API persistent storage diagram

To manage this, the system includes the HouseKeeper cleaning mechanism that helps remove unnecessary data.

Cloud Storage Considerations

For cloud storage solutions, there are often built-in cleaning mechanisms provided by the cloud provider. Depending on the provider's pricing policy, using the built-in cleaning mechanism within our product may lead to additional costs. Therefore, it may be more cost-effective to use the cleaning mechanisms provided by your cloud provider.

The following articles describe native mechanisms of managing object lifecycles in storages:

How Cleaning Mechanism Works

The cleaning mechanism operates on a sliding window principle, where all data older than a specified time is deleted. This is managed by a component called HouseKeeper, which uses Time-To-Live (TTL) settings to determine which data to remove.

To configure the cleaning mechanism and the HouseKeeper component, refer to the Storage configuration settings.

Handling Data When Migrating From Previous Versions

Once upgrading from previous versions of the Face SDK Web Service to the version 7.6, it's important to be aware of changes in how data is managed. By default, the cleanup feature for the Session API transactions is disabled, meaning the data will not be automatically removed.

If you choose to enable the cleanup feature, the data will be removed according to the specified retention window set in the HouseKeeper configuration.