Create privacy request with multiple users and identity types in privacy service API
This article explains how to create a privacy JSON request with multiple users and identity types using the Privacy Service API. The Privacy Service UI allows only a single namespace type per request, but with the API, you can build a request with multiple identity types in a single JSON payload. This article includes a sample JSON and a step-by-step explanation of how to configure the request.
Description description
Environment
Adobe Experience Platform
Issue/Symptoms
The Privacy Service interface (UI) currently only supports creating requests with a single identity type per request. However, when using the Privacy Service API, it’s possible to create a JSON request that includes multiple identity types for different users. This method is useful for handling privacy requests involving various data sources and identifiers for a single or multiple users.
Here is an example JSON for a privacy request involving multiple users and identity types:
{
"companyContexts": [
{
"namespace": "imsOrgID",
"value": "{{IMS ORG}}"
}
] ,
"users": [
{
"key": "dbt26cf6-1942-4c4a-82bd-d790e647cxxx",
"action": [
"access"
] ,
"userIDs": [
{
"namespace": "email",
"value": "dsmith@axxx.com",
"type": "standard"
},
{
"namespace": "ECID",
"type": "standard",
"value": "443636576799758681021090721xxx",
"isDeletedClientSide": false
}
]
},
{
"key": "8dd7e4d8-13d3-442f-85d8-5e2f0779exxx",
"action": [
"access",
"delete"
] ,
"namespace": "email",
"value": "ajones@axxx.com",
"type": "standard"
},
{
"namespace": "CRM ID",
"value": "12AD45FE30xxx",
"type": "analytics"
}
] ,
"include": [
"Analytics",
"AdobeCloudPlatform",
"profileService"
] ,
"regulation": "сра"
}
Resolution resolution
To create a new privacy request using the Privacy Service API, follow these steps:
-
Start by crafting the JSON request. This includes defining the
companyContexts
, which includes your Adobe organization ID for authentication. This ID matches the value you provide in the request headers. -
For each user, assign a unique key and provide their identifiers under userIDs. These identifiers should include the namespace, type, and value. In the sample, users have identifiers such as email, ECID, and CRM ID.
-
For each user, include an action array specifying the actions to perform on the user’s data, such as access, delete, or both.
-
Under the include field, list the Adobe Experience Cloud products (such as Analytics, AdobeCloudPlatform, profileService) that will process the privacy request.
-
Specify the regulation under which the request is filed. Supported values include:
- gdpr (European Union)
- ccpa (California)
- lgpd_bra (Brazil)
- nzpa_nzl (New Zealand)
- pdpa_tha (Thailand)
- apa_aus (Australia)
- cpa (Colorado)
- cpra_usa (California)
- ctdpa (Connecticut)
- hipaa_usa (USA)
- ucpa_usa (Utah)
- vcdpa_usa (Virginia)
-
After configuring the JSON request, send it to the Privacy API’s jobs endpoint. A successful response will return details of the newly created job, which can be tracked or processed further.
By following these steps, you can create a comprehensive privacy request for multiple users and identity types, ensuring compliance with the relevant privacy regulations.