Scrub Visitor Data

To satisfy GDRP, CCPA and similar requests

You can remove personally identifiable information (PII) for any website visitors that you have identified to ServiceBell using our Identification API.

For detailed information on the endpoints used, refer to the Organization Resource page.

Example Script

This script assumes Python3 and that the Python requests library has been installed.

scrub_visitors.py

import requests


# Setup re-usable values
# Note: The API Key value here is a fake example, storing 
#       in code is not recommended
base_url = "https://api.servicebell.com"
headers = {
    "X-Api-Key": "vMLmfTyh.uN4C-cBme8iBfHqmMSkOwdlH_gdFipxglxEdOS7pKSU",
    "Content-Type": "application/json"
}


# Get the Organization ID tied to your API Key
response = requests.get(f"{base_url}/public/api/v1/org", 
                        headers=headers)
assert response.ok

# Save the Organization ID from the response
org_id = response.json()["id"]


# Setup the Visitors we'd like to search/scrub
# Can be customId's or email addresses
visitors = ["766554", "[email protected]"]

# POST request to redact the information for those two visitors
# Note: Takes a JSON body with a list of the visitor identities
url = f"{base_url}/public/api/v1/org/{org_id}/visitorscrub"
response = requests.post(url, json={"identities": visitors},
                         headers=headers)
assert response.ok

# Response body example:
# [{'customId': None,
#   'customMetadata': {'displayName': 'REDACTED'},
#   'id': '747a2bd8-d1aa-4736-beb5-1ebe142439f0',
#   'orgId': 1222456005},
#  {'customId': None,
#   'customMetadata': {'displayName': 'REDACTED'},
#   'id': 'b81085e2-ae40-4303-9050-9c38784c7454',
#   'orgId': 1222456005}]