Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Privacy Service API (1.0)

Download OpenAPI specification:Download

Adobe Experience Platform Privacy Service provides a common, centralized facilitation of access/delete requests and opt-out-of-sale requests for private data on Adobe Experience Cloud applications. The service includes a UI for selecting and creating requests, a business layer that processes incoming and outgoing traffic, a data store for audit and logging information, and temporary storage for data retrieval while requests are pending or waiting to be viewed. Use the Privacy Service API to create or manage privacy jobs to access or delete user information, manage opt-out requests, and more. - Related documentation:

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.

Privacy jobs

Privacy jobs process customer privacy requests, including access/delete and opt-out requests. Each privacy job is tracked under a specific regulation.

List privacy jobs

NOTE: For more information on using this operation, see the privacy jobs endpoint guide on Experience League.

Request
query Parameters
regulation
required
string

The privacy regulation to return jobs from.

Enum: "gdpr" "ccpa" "pdpa_tha" "lgpd_bra" "nzpa_nzl"
size
integer <int32> <= 100
Default: 25

The number of jobs to return in the response body.

page
integer <int32>
Default: 1

The page index to return results from when the result count exceeds the limit defined by the size parameter.

status
string

Filters jobs by processing status.

Enum: "complete" "processing" "submitted" "error"
fromDate
string

Limits results to those processed after a specified date. Accepts the format YYYY-MM-DD. If this parameter (and a corresponding toDate) is not provided, the resulting jobs default to the last seven days.

toDate
string

Limits results to those processed before a specified date. Accepts the format YYYY-MM-DD. If this parameter (and a corresponding fromDate) is not provided, the resulting jobs default to the last seven days.

filterDate
string

Limits results to those processed on a specified date. Accepts the format YYYY-MM-DD.

header Parameters
Authorization
required
string

The access token provided after authorization in the format Bearer {ACCESS_TOKEN}. See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-api-key
required
string

Your specific API key for your unique Platform configuration ({API_KEY}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-gw-ims-org-id
required
string

Unique Identifier for your IMS Organization ({IMS_ORG}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal service error

get/jobs
Response samples
application/json
{
  • "totalRecords": 4,
  • "jobDetails": [
    ]
}

Create a privacy job

NOTE: For more information on using this operation, see the privacy jobs endpoint guide on Experience League.

Request
header Parameters
Authorization
required
string

The access token provided after authorization in the format Bearer {ACCESS_TOKEN}. See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-api-key
required
string

Your specific API key for your unique Platform configuration ({API_KEY}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-gw-ims-org-id
required
string

Unique Identifier for your IMS Organization ({IMS_ORG}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

Content-Type
required
string

The type of content being sent in the body of the request. Must be set to application/json when providing JSON request payloads.

Request Body schema: application/json
required

The payload for a privacy creation request must include company context information, a list of user IDs and namespaces, and a valid regulation code. See the privacy jobs endpoint guide for more details on how to format privacy request payloads.

required
Array of objects (PrivacyCompanyContextDetails) non-empty

An array containing authentication information for your organization. It is required that one of the identifiers uses imsOrgId as its namespace, with its value containing the unique ID for your IMS Organization.

Additional identifiers can be product-specific company qualifiers (such as Adobe Campaign) which identify an integration with an Adobe application belonging to your organization. Potential values include account names, client codes, tenant IDs, or other application identifiers.

required
Array of objects (PrivacyUserDetails) non-empty

An array containing a collection of at least one user whose information you would like to access or delete. A maximum of 1000 user IDs can be provided in a single request.

include
required
Array of strings non-empty unique

An array containing the product code strings of each Adobe Experience Cloud application to process the request under. Only include values for products that your organization has an integration with. If multiple product values are included, separate jobs are created for each product.

expandIds
string

An optional property that, when set to true, represents an optimization for processing the IDs in the specified applications (currently only supported by Adobe Analytics). If omitted, this value defaults to false.

Enum: "true" "false"
priority
string

An optional property used by Adobe Analytics that sets the priority for processing requests. Accepted values are normal and low. If priority is omitted, the default behavior is normal.

Enum: "low" "normal"
region
string

The region code for the request.

regulation
string

The regulation for the privacy job. The following values are accepted:

  • gdpr (European Union)
  • ccpa (California)
  • lgpd_bra (Brazil)
  • nzpa_nzl (New Zealand)
  • pdpa_tha (Thailand Personal Data Protection Decree)
  • apa_aus Australia
  • cpa (Colorado)
  • cpra_usa (California)
  • ctdpa (Connecticut)
  • ctdpa_usa (Connecticut)
  • hipaa_usa (United States of America)
  • ucpa_usa (Utah)
  • vcdpa_usa (Virginia)
Enum: "gdpr" "ccpa" "lgpd_bra" "nzpa_nzl" "pdpa_tha" "apa_aus" "cpa" "cpra_usa" "ctdpa" "ctdpa_usa" "hipaa_usa" "ucpa_usa" "vcdpa_usa"
Responses
202

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal service error

post/jobs
Request samples
application/json
{
  • "companyContexts": [
    ],
  • "users": [
    ],
  • "include": [
    ],
  • "expandIds": false,
  • "priority": "normal",
  • "regulation": "ccpa"
}
Response samples
application/json
{
  • "requestId": "16203318964318668RX-054",
  • "totalRecords": 3,
  • "jobs": [
    ]
}

Retrieve a privacy job

NOTE: For more information on using this operation, see the privacy jobs endpoint guide on Experience League.

Request
path Parameters
JOB_ID
required
string

The unique ID of a privacy job.

header Parameters
Authorization
required
string

The access token provided after authorization in the format Bearer {ACCESS_TOKEN}. See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-api-key
required
string

Your specific API key for your unique Platform configuration ({API_KEY}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-gw-ims-org-id
required
string

Unique Identifier for your IMS Organization ({IMS_ORG}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

Responses
200

Success

400

Bad request

403

Missing access permissions

404

Not found

500

Internal service error

get/jobs/{JOB_ID}
Response samples
application/json
{
  • "jobId": "string",
  • "requestId": "string",
  • "userKey": "string",
  • "action": "access",
  • "status": "string",
  • "submittedBy": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "lastModifiedDate": "2019-08-24T14:15:22Z",
  • "qualifiedCount": 0,
  • "userIds": [
    ],
  • "productResponses": [
    ],
  • "downloadUrl": "string",
  • "childJobs": [
    ],
  • "regulation": "string"
}

Consent

Certain privacy regulations require businesses to honor customer opt-out-of-sale requests. The Privacy Service API allows you to process these opt-out requests for Experience Cloud applications.

Process a customer opt-out-of-sale request

NOTE: For more information on using this operation, see the consent endpoint guide on Experience League.

Request
header Parameters
Authorization
required
string

The access token provided after authorization in the format Bearer {ACCESS_TOKEN}. See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-api-key
required
string

Your specific API key for your unique Platform configuration ({API_KEY}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

x-gw-ims-org-id
required
string

Unique Identifier for your IMS Organization ({IMS_ORG}). See the guide on getting started with the Privacy Service API for steps on how to obtain this value.

Request Body schema: application/json
required

The payload for a consent request must include an optOutOfSale property and a list of user IDs (categorized by namespace).

optOutOfSale
boolean

When set to true, indicates that the users provided under entities wish to opt-out of the sale or sharing of their personal data.

Array of objects (PrivacySaleConsentDetails)

An array of objects indicating the users who the consent request applies to. Each object contains a namespace and an array of values to match individual users with that namespace.

requestId
string

An optional ID value for the request.

transactionId
string

An optional ID value for the transaction that generated the consent request.

orgId
string

An optional ID value for the organization that made the consent request.

Responses
202

Accepted

400

Bad request

403

Missing access permissions

404

Not found

500

Internal service error

post/consent
Request samples
application/json
{
  • "optOutOfSale": true,
  • "entities": [
    ]
}