Account Data Transfer

Download App Store information, app install, and push notification activity on behalf of people who use your app.

Overview

Use the Account Data Transfer web API to request and download information about the people who use your app. The data available relates to someone’s use of Apple’s App Store, including information such as previous transactions and downloads. It also contains information related to app install and push notification activity.

Understand scopes

A scope identifies a subset of data that your apps and website can access from a single Apple Account, with approval from the individual whose data you request. Only select the applicable scopes for your apps and website.

User information scope

The developer portal selects the data-transfer-user-profile scope automatically when you request access to another scope.

data-transfer-user-profile: A read-only scope that you use to request one or more scopes such as App Store information, app install or push notification activity about a user.

App Store information scopes

appstore-info-account-data-for-EU-users: A read-only scope you use to access App Store account information about users in the EU.
appstore-info-account-data-for-JP-users: A read-only scope you use to access App Store account information about users in Japan.
appstore-info-account-data-for-UK-users: A read-only scope you use to access App Store account information about users in the UK.

App install and push notification activity scopes

app-install-activity-account-data-for-EU-users: A read-only scope you use to access app install and push notification activity about users in the EU.
app-install-activity-account-data-for-JP-users: A read-only scope you use to access app install and push notification activity about users in Japan.
app-install-activity-account-data-for-UK-users: A read-only scope you use to access app install and push notification activity about users in the UK.

Request permission for the specific scopes

To get permission for your App ID or Services ID to request App Store information and app install and push notification scopes for users in the EU, the UK, or Japan, follow the instructions at Request access to the Account Data Transfer API.

note:

This API returns account data about users in the EU, UK, and Japan. If you’re an app developer and need to transfer data related to App Store information, app install, or push notification activity for your app instead, use the App Data Transfer API. If you request access to the Account Data Transfer API, and Apple grants your request, you don’t need to supply the consent_mode query parameter when you request an authorization token for the App Data Transfer API.

If you have any questions about the data made available in this API, including about how Apple applies privacy measures to protect user privacy and complies with legal obligations, contact Apple through Feedback Assistant by selecting the following option:

Developer Tools & Resources > Data Portability > Account Data Transfer API

Learn more about how to use Feedback Assistant.

Understand the difference between scope types

When making requests, it’s important to understand the scopes you can combine in a single request, and the scopes you need to request separately, as well as which are one-time requests and which can be either one-time or recurring requests. The following table describes the relationships between the available scopes:.

Scope	Additional scopes you can add to the same request	Request frequency
`app-install-activity-account-data-for-EU-users`	`appstore-info-account-data-for-EU-users`	One-time and recurring
`app-install-activity-account-data-for-UK-users`	`appstore-info-account-data-for-UK-users`	One-time and recurring
`appstore-info-account-data-for-EU-users`	`app-install-activity-account-data-for-EU-users`	One-time and recurring
`appstore-info-account-data-for-UK-users`	`app-install-activity-account-data-for-UK-users`	One-time and recurring
`appstore-info-account-data-for-JP-users`	`app-install-activity-account-data-for-JP-users`	One-time and recurring
`app-install-activity-account-data-for-JP-users`	`appstore-info-account-data-for-JP-users`	One-time and recurring

Set required HTTP headers for the requested scopes

X-Apple-Transaction-Id: Set the value to a UUID that uniquely identifies the request. If you need to contact Apple to get support, quote the UUID of the request for which you need help.
Authorization: Set the value to Bearer <ACCESS_TOKEN> to assert that your app is authorized to fetch data with the data-transfer-user-profile scope, one or more of the relevant App Store information, app install and push notification, or registration and activation scopes.

Set the request frequency

When making an HTTP POST request to the Submit request endpoint, requesting the App Store or app install activity scope, you can request a one time or recurring request, depending on the specified scopes:

To make a one-time request, set the mode key to ONE_TIME. To make recurring requests, for app install or push notification activity, use one of the following values:

DAILY_30: One recurring request every day for 30 days
WEEKLY_180: One recurring request every week for 180 days

Save the server request ID and check delay value

The Apple server returns a request ID, which you use when you get the request status, request download URLs, or cancel the request. For recurring requests, the Apple server returns a request ID, along with the parent ID that identifies the series of recurring requests.

The response from the server also contains a statusCheckDelay, which is the number of seconds you need to wait before checking the status of the request. You can cancel a request before this time by making a POST request to the Cancel request endpoint.

If you submit a DAILY_30 recurring request and don’t resubmit the recurring instance each subsequent day, the recurring request expires 40 days after submission of the initial request.

If you submit a WEEKLY_180 recurring request and don’t resubmit the recurring instance each subsequent week, the recurring request expires 190 days after submission of the initial request.

Find the request status

The data corresponding to the request you submitted isn’t available immediately. After the status-check delay expires, make a GET request to Get one-time request status or Get recurring request status. Use the endpoint that corresponds to the scope of the requested report and include the request identifier in the path.

If the job status is completed or completed_with_error, the data associated with the request is ready to download.

Transfer data

Get the download URLs for a completed request by making a GET request to Get one-time request download URLs or Get recurring request download URLs, including the request identifier in the path.

The response contains a list of URLs to which you make GET requests, to retrieve the person’s data.

Download URLs are available for 3 days after the download request completes. The URLs you receive are valid for 15 minutes after you request them.

For information on the content and terms used in the files you download, see Data and Privacy.

Resubmit recurring requests

For app install or push notification requests, add the next instance of a recurring request to the queue by making a POST request to the Resubmit request endpoint. Include the parent request identifier and the request identifier of the most recent instance in your request.

The server’s response contains the request identifier of the new request, and a delay to wait before you can check the new request’s status.