API Reference
Log In
API Reference

GDPR-anonymize an Applicant, preserving selected data keys

Anonymizes an applicant's personal data per GDPR right-to-erasure, except for the data/structured_data/secure_data keys listed in data_whitelist, which are preserved as-is. Idempotent — a no-op if the applicant has already been anonymized. A scoped API token needs create and delete access to applicants (applicants: cd). Without create access the request returns 401, and without delete access it returns 403.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
data_whitelist
array of strings | null

Keys of the applicant's data/structured_data/secure_data fields to preserve instead of clearing

data_whitelist
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json