The Delete User's PII Data API deletes users' PII data. Insider One does not allow the deletion of the user's last remaining identifier. In addition, if this value is Personally Identifiable Information (PII) data, such as an email or phone number, it would not be deleted. Thanks to this endpoint, you can delete these values associated with users; if the user is known and their only identifier is email or phone number, the user becomes anonymous. For example, you can delete all PII data of registered users when they revoke their data-sharing permissions.
The user attributes marked as PII are unconditionally deleted with this API.
This action cannot be undone. Please carefully consider before proceeding.
The Delete User Profile API fully removes a user and all associated data. In contrast, the Delete User's PII Data API only deletes Personally Identifiable Information (PII) and does not remove the user profile entirely. This API anonymizes users by removing PII (such as email or phone) if it’s their only identifier. Still, it retains the user profile, making it useful for removing privacy-related data without complete deletion.
Endpoint and Headers
Two different endpoints are available for this API:
You can convert a user into an anonymous user using the insider_id (profile ID).
POST https://unification.useinsider.com/api/contact/v1/anonymize
You can convert a user into an anonymous user using their identifier.
POST https://unification.useinsider.com/api/user/v1/anonymize
Visit our Postman collection to test this request.
Headers
Header | Sample Value | Description |
|---|---|---|
X-PARTNER-NAME | mybrand | This is your partner name. Navigate to InOne > Inone Settings > Account Settings to copy your partner name. The partner name should be lowercase. |
X-REQUEST-TOKEN | 1a2b3c4d5e6f | This key is required to authorize your request. Refer to API Authentication Tokens to generate your token. |
Content-Type | application/json | This header specifies the media type of the resource. |
Body Parameters
Parameter | Description | Data Type | Required |
|---|---|---|---|
User's email address. | String | No | |
phone_number | User's phone number in E.164 format (e.g., +6598765432) | String | No |
uuid | User's unique user identifier. | String | No |
name | Attribute. User's name. | String | No |
surname | Attribute. User's surname. | String | No |
birthday | Attribute. User's birthday in RFC 3339 format (e.g., 1993-03-12T00:00:00Z). Note: Send the birthdays without the time offset. | Datetime | No |
gender | Attribute. Gender of the user. | String | No |
age | Attribute. Age of the user | Number | No |
country | Attribute. Country information of the user in ISO 3166-1 alpha-2 format. | String | No |
city | Attribute. City information of the user. | String | No |
Sample Request
The sample below displays a request to convert a user into an anonymous user using their insider_id, an internal profile ID maintained by Insider One.
curl --location --request POST 'https://unification.useinsider.com/api/user/v1/anonymize' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
“insider_id”: “111ab184-f77e-4cba-123e-9abca4332211"
}'The sample below shows a request to convert a user to an anonymous user using their identifier (in this case, an email address).
curl --location --request POST 'https://unification.useinsider.com/api/user/v1/anonymize' \
--header 'X-PARTNER-NAME: mybrand' \
--header 'X-REQUEST-TOKEN: 1a2b3c4d5e6f' \
--header 'Content-Type: application/json' \
--data-raw '{
"identifiers": {
"email": "example@useinsider.com"
}
}'Sample Responses
200 OK
This response returns when the request is successful.
404 Not Found
The response below returns when you send the wrong identifiers.
{"error":"no such user for these identifiers: no data"}Limitations
All functions must be executed with a simple HTTPS POST request.
Only PII data delete requests can be sent via this API. No data can be retrieved.
The request token should be provided in the request header. If the token is incorrect, the operation will not be executed.
The rate limit is 500 requests per minute.
A single HTTPS POST request can pass only 1 record (users).
The value of X-PARTNER-NAME header should be lowercase.
The default limit shown here is a standard baseline. If your use case requires higher capacity, feel free to reach out to the Insider One team — we can adjust it to fit your needs.