User Data Deletion

Erases the data Gurdx holds about one of your end users, so you can honor deletion requests under privacy laws.

Overview#

When one of your customers asks to be forgotten, account/users/delete removes what Gurdx stored about them. You identify the person with value: an email address, a phone number or the user ID you pass as userID in other calls. The response is a count of removed records per category: transaction_data, ips, profanity_data, emails, phone_numbers and ibans. It is a DELETE method.

When to use it#

• A user exercises a right to erasure under GDPR or a similar regulation.
• You close an account and want the associated analysis history removed too.
• You need to clean up after a test that used real identifiers.

How it works#

Gurdx looks for the value across the request history and the data it derived for your account, deletes the matches and reports how many records of each kind were removed. A category with 0 simply had nothing for that user. Deletion is permanent and cannot be undone, so confirm the request first.

Warning: Deletion removes Gurdx's records only. Your own database, logs and backups, and any copies you made of API responses, are yours to purge.

Because analysis events use whatever identifier you supplied, use the same identifier style in the deletion call. If you used the userID option consistently, passing that ID removes every request tagged with it.

Notes#

• This method is free: it does not consume your monthly quota and is not billed. It is included in every plan.
• There is a daily deletion limit per account. When you reach it, error 126 (too_many_deletions) is returned; wait for the next day and retry.
• Empty or malformed input returns error 125 (invalid_user_value), and an unrecognized identifier type returns 124 (invalid_user_type), always with HTTP 200.
• It raises no events and is not affected by custom rules or blacklists, though blacklist entries you created yourself are managed separately in your dashboard.
• Test mode returns a plausible fake count and deletes nothing.

Request#

• Authenticate with the key parameter or an Authorization: Bearer header.
• Free — not counted against your quota.
• Available on: Free trial Standard Premium Pay-as-you-go

Parameters#

Every method also accepts format, lang, mode, userID. See Options.

Code samples#

curl -X DELETE "https://gurdx.cretip.com/api/account/users/delete" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "value=user@example.com"

<?php

$ch = curl_init('https://gurdx.cretip.com/api/account/users/delete');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer YOUR_API_KEY'],
    CURLOPT_POSTFIELDS => http_build_query(['value' => 'user@example.com']),
]);
$result = json_decode(curl_exec($ch), true);
print_r($result);

const res = await fetch('https://gurdx.cretip.com/api/account/users/delete', {
  method: 'DELETE',
  headers: { Authorization: 'Bearer YOUR_API_KEY' },
  body: new URLSearchParams({ value: 'user@example.com' }),
});
console.log(await res.json());

import requests

res = requests.delete(
    "https://gurdx.cretip.com/api/account/users/delete",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    data={"value": "user@example.com"},
)
print(res.json())

Response#

Success#

{
    "data": {
        "transaction_data": 25,
        "ips": 4,
        "profanity_data": 3,
        "emails": 1,
        "phone_numbers": 1,
        "ibans": 10
    },
    "status": "success"
}

Error#

Errors are delivered with HTTP 200 — always check the status field.

{
    "status": "error",
    "code": 101,
    "type": "invalid_key",
    "description": "The API Key is missing or invalid."
}

Response fields#