Data Deletion

The Data Deletion functionality in DataGuard CPM allows customers to delete individual or multiple citizens programmatically via API. This can be used to support automated clean-up processes or synchronise citizen records across systems. All deletion is performed via API, no user interface is available at the moment.

How it works

Single citizen deletion

Use the Delete a single citizen by externalRef endpoint to delete one citizen.

• The deletion is executed immediately.
• All associated data (permissions & preferences) is also deleted.
• The deletion of permissions & preferences happens asynchronously, but completes effectively right away.
• There is no confirmation step, the API request will delete the citizen if found.

Bulk deletion

For deleting multiple citizens, submit a bulk deletion job:

1. Prepare a .csv file with one column titled externalRef.
2. Include one citizen externalRef per row.
3. Upload the file using the bulk deletion endpoint.

Example file content:

externalRef
citizen-123
citizen-456
citizen-789

• The file size must not exceed 10MB.
• The job is processed asynchronously.
• You can poll the job status endpoint to track completion.
• If any rows failed to delete, download the failure report as CSV for details.

What gets deleted

Deletion includes:

• Citizen record
• All associated consent and preference data

The deletion is a soft delete in line with your data retention policy. However, deleted citizens cannot be systematically recovered, and the retention is not intended as a restore mechanism.

Important considerations

• There is no confirmation prompt or undo option. Ensure that deletions are intentional.
• Pre-validation should be done client-side, the API will delete any valid externalRef provided.
• Bulk deletions are subject to a 10MB file size limit.