POST Mask customer data.
POST /merchant/{version}/customer/mask
Operation ID: maskCustomerData. Tags: Mask Customer Data, Customer API.
Administrative API to mask specific customer data to satisfy CCPA/GDPR requirements. Customer records are identified by customer ID or email address, and PII fields are replaced with mask characters across all relevant data stores.
The following categories of customer data are masked:
- Names — first name, last name, middle name, initials
- Contact information — email addresses, phone numbers
- Addresses — billing and shipping addresses, including street, city, state/province, ZIP/postal code, and country
- Demographic information — gender, age, date of birth
- Payment information — credit card numbers, card type, expiration dates, billing address
- Loyalty and consent — loyalty enrollment data and related consents
- Identification numbers — driver's license, national ID, and similar identifiers
Masking is applied across relational databases (MySQL), NoSQL databases (DynamoDB), caches (Redis), and data warehouses (Redshift). Object storage (S3) is covered by TTL policies.
Masking is asynchronous. The response returns a requestId and an IN_PROGRESS status. Use the request ID to poll for completion.
Parameters
version(path, string, required) Supported: v1.
Pattern: v1|v2.
Responses
- default
Default response.
Media type:
application/json. Schema:CustomerMaskResponse.