Automate client deletion

This guide demonstrates how to delete client data using our API. In line with compliance obligations, you can automatically identify clients scheduled for deletion by filtering on their deletion_date. Once identified, you can delete the client data—including all PII, files, and associated records—using the API endpoints provided.

Prerequisites

• Amiqus API credentials: Ensure you have valid credentials to authenticate your requests.
• Compliance setup: Confirm that your deletion policies are in place and that the deletion_date is set correctly for each client.

Overview of the flow

Below is a sequence diagram illustrating the process:

Step-by-step guide

1. List all clients with a deletion_date set to today

Begin by calling the list all clients endpoint. Use the deletion_date filter with the value today to retrieve only those clients whose deletion date matches the current day. The response will include an array of client objects, each with a deletion_date indicating that their data is due for deletion.

2. Delete each client

Once you have the list of clients scheduled for deletion, iterate through each client and call the delete a client endpoint. This operation will remove all PII, files, and any other associated data for the client, thereby fulfilling your compliance requirements.

What happens next?

After deleting the client data:

• Log the deletion: Ensure that all deletion actions are logged for audit purposes.
• Review API limits: Monitor your API rate limits to avoid any throttling, particularly if you are processing a large number of clients.
• Verify deletion: Consider implementing additional checks or notifications to confirm that deletions have been successfully executed.

By following these steps, you can efficiently manage the deletion of client data, ensuring that your practices remain compliant with data protection regulations.