### Example Curl Request for Recurring Request Status

Source: https://developer.apple.com/documentation/accountdatatransfer/get-recurring-request-status

This example shows how to make a GET request to the API endpoint using curl. Ensure you replace [ACCESS_TOKEN] with your valid token and use the correct transaction ID.

```bash
% curl -X GET \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Accept: application/json" \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/EABD06C0-9210-47FF-83C4-318CF8520644/7BBBD45D-638B-4DB5-8B02-F23FDB15EDA7

```

--------------------------------

### Example cURL Request for One-Time Request Status

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-status

This example demonstrates how to make a GET request to the Account Data Transfer API to check the status of a one-time download request. Ensure you replace [ACCESS_TOKEN] with your actual token and provide a valid requestId.

```curl
% curl -X GET \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Accept: application/json" \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/11619695-72C0-4FFD-858A-1E152DCF0838

```

--------------------------------

### Example Response for One-Time Request Status

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-status

This is an example of a successful response when checking the status of a one-time download request. The response indicates the job status and provides a recommended delay for the next status check.

```json
{
  "jobStatus": "in_progress",
  "status": "success",
  "statusCheckDelay": 86400
}

```

--------------------------------

### Resubmit Request cURL Example

Source: https://developer.apple.com/documentation/accountdatatransfer/resubmit-request

Example of how to call the resubmit endpoint using cURL, including required headers and JSON payload.

```bash
% curl -X POST \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Content-Type: application/json" \
  -d '{ "parentRequestId": "EABD06C0-9210-47FF-83C4-318CF8520644", "requestId": "7BBBD45D-638B-4DB5-8B02-F23FDB15EDA7" }' \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/resubmit
```

--------------------------------

### POST /submit-request

Source: https://developer.apple.com/documentation/accountdatatransfer

Starts preparing a user's data for download. Supports one-time or recurring request modes.

```APIDOC
## POST /submit-request

### Description
Starts preparing someone's data for download. Use the `mode` parameter to specify if the request is one-time or recurring.

### Method
POST

### Endpoint
/submit-request

### Parameters
#### Request Body
- **mode** (string) - Required - The frequency of the request. Values: `ONE_TIME`, `DAILY_30`, `WEEKLY_180`.

### Response
#### Success Response (200)
- **requestId** (string) - Unique identifier for the request.
- **statusCheckDelay** (integer) - Number of seconds to wait before checking status.
```

--------------------------------

### GET Request for Recurring Download URLs

Source: https://developer.apple.com/documentation/accountdatatransfer/get-recurring-request-download-urls

Use this cURL command to make a GET request to the API endpoint for fetching download URLs. Ensure you replace placeholder values with actual tokens and IDs. The `Authorization` and `X-Apple-Transaction-Id` headers are required.

```bash
% curl -X GET \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Accept: application/json" \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/fetch/EABD06C0-9210-47FF-83C4-318CF8520644/7BBBD45D-638B-4DB5-8B02-F23FDB15EDA7

```

--------------------------------

### Retrieve download URLs using cURL

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-download-urls

Example request using cURL to fetch data URLs for a specific request ID.

```bash
% curl -X GET \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Accept: application/json" \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/fetch/11619695-72C0-4FFD-858A-1E152DCF0838
```

--------------------------------

### GET /api/transfer/accountdata/fetch/{requestId}

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-download-urls

Retrieves the download URLs for a specific one-time account data transfer request.

```APIDOC
## GET /api/transfer/accountdata/fetch/{requestId}

### Description
Retrieves URLs to download someone's account data for a one-time request.

### Method
GET

### Endpoint
https://accountdatatransfer.apple.com/api/transfer/accountdata/fetch/{requestId}

### Parameters
#### Path Parameters
- **requestId** (string) - Required - A UUID that identifies the one-time request.

### Response
#### Success Response (200)
- **assetInfo** (array) - A list of URLs to download the data.
- **jobStatus** (string) - The status of the job (e.g., completed).
- **status** (string) - The status of the request (e.g., success).

#### Response Example
{
  "assetInfo": [
    "https://assets.example.com/1.zip",
    "https://assets.example.com/2.zip"
  ],
  "jobStatus": "completed",
  "status": "success"
}
```

--------------------------------

### POST /api/transfer/accountdata/submit

Source: https://developer.apple.com/documentation/accountdatatransfer/submit-request

Starts preparing user data for download. This endpoint accepts a JobSubmission object to define the request mode.

```APIDOC
## POST /api/transfer/accountdata/submit

### Description
Starts preparing someone’s data for download. This endpoint supports both one-time and recurring download requests.

### Method
POST

### Endpoint
https://accountdatatransfer.apple.com/api/transfer/accountdata/submit

### Request Body
- **mode** (string) - Required - The mode of the download request (e.g., "ONE_TIME", "DAILY_30").

### Request Example
{
  "mode": "ONE_TIME"
}

### Response
#### Success Response (200)
- **requestId** (string) - The unique identifier for the request.
- **status** (string) - The current status of the request.
- **statusCheckDelay** (integer) - The delay in seconds before checking the status again.
- **parentRequestId** (string) - Optional - The parent request ID for recurring downloads.

#### Response Example
{
  "requestId": "11619695-72C0-4FFD-858A-1E152DCF0838",
  "status": "in_progress",
  "statusCheckDelay": 86400
}
```

--------------------------------

### GET /download-urls

Source: https://developer.apple.com/documentation/accountdatatransfer

Retrieves the download URLs for a completed data request.

```APIDOC
## GET /download-urls/{requestId}

### Description
Get URLs to retrieve someone's data. These URLs are valid for 15 minutes.

### Method
GET

### Endpoint
/download-urls/{requestId}

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The unique identifier for the request.

### Response
#### Success Response (200)
- **urls** (array) - A list of URLs to download the data.
```

--------------------------------

### Get One-Time Request Status Endpoint

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-status

Use this GET endpoint to find the status of a one-time download request. Requires a valid requestId.

```http
GET https://accountdatatransfer.apple.com/api/transfer/accountdata/{requestId}
```

--------------------------------

### Get recurring request status

Source: https://developer.apple.com/documentation/accountdatatransfer/requeststatus

Get the status of an instance of a recurring download request.

```APIDOC
## GET /account/data/transfer/recurring/request/status

### Description
Retrieves the status of an instance of a recurring data download request.

### Method
GET

### Endpoint
`/account/data/transfer/recurring/request/status`

### Query Parameters
- **recurringRequestId** (string) - Required - The unique identifier for the recurring request instance.

### Response
#### Success Response (200)
- **RequestStatus** (object) - An object containing the status of the recurring request instance.
```

--------------------------------

### Get one-time request status

Source: https://developer.apple.com/documentation/accountdatatransfer/requeststatus

Find the status of a one-time download request.

```APIDOC
## GET /account/data/transfer/request/status

### Description
Retrieves the status of a one-time data download request.

### Method
GET

### Endpoint
`/account/data/transfer/request/status`

### Query Parameters
- **requestId** (string) - Required - The unique identifier for the one-time request.

### Response
#### Success Response (200)
- **RequestStatus** (object) - An object containing the status of the request.
```

--------------------------------

### Get Download URLs API

Source: https://developer.apple.com/documentation/AccountDataTransfer

Retrieves URLs to download the requested user data. URLs are valid for a limited time.

```APIDOC
## 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.

### Get one-time request download URLs
Get URLs to retrieve someone’s data.

### Method
GET

### Endpoint
`/path/to/download/urls/{requestId}`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The identifier of the completed request.

### Response
#### Success Response (200)
- **DownloadLinks** (object) - An object that contains URLs to download someone’s account data.
  - **downloadUrls** (array) - A list of URLs to retrieve the data.

#### Response Example
```json
{
  "downloadUrls": [
    "https://example.com/data/part1.zip",
    "https://example.com/data/part2.zip"
  ]
}
```

---

### Get recurring request download URLs
Get URLs to download a snapshot of someone’s data from a recurring series.

### Method
GET

### Endpoint
`/path/to/recurring/download/urls/{requestId}`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The identifier of the completed recurring request instance.

### Response
#### Success Response (200)
- **DownloadLinks** (object) - An object that contains URLs to download someone’s account data.
  - **downloadUrls** (array) - A list of URLs to retrieve the data.

#### Response Example
```json
{
  "downloadUrls": [
    "https://example.com/data/snapshot1.zip"
  ]
}
```
```

--------------------------------

### Fetch one-time request download URLs via GET

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-download-urls

The endpoint requires a valid access token and a transaction ID in the header to retrieve data URLs for a specific request ID.

```http
GET https://accountdatatransfer.apple.com/api/transfer/accountdata/fetch/{requestId}
```

--------------------------------

### Get one-time request status

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-status

Retrieves the status of a previously initiated one-time download request for account data.

```APIDOC
## GET /api/transfer/accountdata/{requestId}

### Description
Find the status of a one-time download request.

### Method
GET

### Endpoint
https://accountdatatransfer.apple.com/api/transfer/accountdata/{requestId}

### Parameters
#### Path Parameters
- **requestId** (string) - Required - A UUID that identifies the download request.

### Request Example
```bash
curl -X GET \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Accept: application/json" \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/11619695-72C0-4FFD-858A-1E152DCF0838
```

### Response
#### Success Response (200 OK)
- **jobStatus** (string) - Indicates the current status of the data transfer job (e.g., "in_progress").
- **status** (string) - General status of the request (e.g., "success").
- **statusCheckDelay** (integer) - The recommended delay in seconds before checking the status again.

#### Response Example
```json
{
  "jobStatus": "in_progress",
  "status": "success",
  "statusCheckDelay": 86400
}
```

#### Error Responses
- **400 Bad Request**: Indicates a malformed request.
- **403 Forbidden**: Indicates that the request is not authorized.
- **500 Internal Server Error**: Indicates a server-side error.
```

--------------------------------

### GET /request-status

Source: https://developer.apple.com/documentation/accountdatatransfer

Retrieves the status of a previously submitted one-time or recurring download request.

```APIDOC
## GET /request-status/{requestId}

### Description
Find the status of a download request. If the status is `completed` or `completed_with_error`, the data is ready for download.

### Method
GET

### Endpoint
/request-status/{requestId}

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The unique identifier for the request.
```

--------------------------------

### GET /api/transfer/accountdata/{parentRequestId}/{requestId}

Source: https://developer.apple.com/documentation/accountdatatransfer/get-recurring-request-status

Retrieves the status of a specific instance of a recurring download request.

```APIDOC
## GET /api/transfer/accountdata/{parentRequestId}/{requestId}

### Description
Get the status of an instance of a recurring download request.

### Method
GET

### Endpoint
https://accountdatatransfer.apple.com/api/transfer/accountdata/{parentRequestId}/{requestId}

### Parameters
#### Path Parameters
- **parentRequestId** (string) - Required - A UUID that identifies the series of recurring download requests.
- **requestId** (string) - Required - A UUID that identifies the individual request.

### Response
#### Success Response (200)
- **jobStatus** (string) - The current status of the job (e.g., in_progress).
- **status** (string) - The status of the request (e.g., success).
- **statusCheckDelay** (integer) - The delay in seconds before checking the status again.

#### Response Example
{
  "jobStatus": "in_progress",
  "status": "success",
  "statusCheckDelay": 86400
}
```

--------------------------------

### GET /api/transfer/accountdata/fetch/{parentRequestId}/{requestId}

Source: https://developer.apple.com/documentation/accountdatatransfer/get-recurring-request-download-urls

Retrieves the download URLs for a specific snapshot within a recurring data transfer request sequence.

```APIDOC
## GET /api/transfer/accountdata/fetch/{parentRequestId}/{requestId}

### Description
Get URLs to download a snapshot of someone’s data from a recurring series.

### Method
GET

### Endpoint
https://accountdatatransfer.apple.com/api/transfer/accountdata/fetch/{parentRequestId}/{requestId}

### Parameters
#### Path Parameters
- **parentRequestId** (string) - Required - A UUID that identifies the recurring sequence of download requests.
- **requestId** (string) - Required - A UUID that identifies the individual download request in the recurring sequence.

### Response
#### Success Response (200)
- **assetInfo** (array) - A list of URLs to download the account data.
- **jobStatus** (string) - The status of the job (e.g., completed).
- **status** (string) - The status of the request (e.g., success).

#### Response Example
{
  "assetInfo": [
    "https://assets.example.com/1.zip",
    "https://assets.example.com/2.zip"
  ],
  "jobStatus": "completed",
  "status": "success"
}
```

--------------------------------

### Resubmit Request API

Source: https://developer.apple.com/documentation/AccountDataTransfer

Enqueues the next instance of a recurring request for app install or push notification data.

```APIDOC
## 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.

### Resubmit request
Enqueue the next instance of a recurring request.

### Method
POST

### Endpoint
`/path/to/resubmit/request`

### Parameters
#### Request Body
- **parentRequestId** (string) - Required - The identifier of the parent recurring request.
- **currentRequestId** (string) - Required - The identifier of the most recent instance of the recurring request.

### Request Example
```json
{
  "parentRequestId": "parent-uuid-1234",
  "currentRequestId": "instance-uuid-5678"
}
```

### Response
#### Success Response (200)
- **ResubmissionResponse** (object) - An object that represents a resubmitted recurring download request.
  - **newRequestId** (string) - The request identifier of the newly created request instance.
  - **statusCheckDelay** (integer) - The delay in seconds before checking the status of the new request.

#### Response Example
```json
{
  "newRequestId": "new-instance-uuid-9012",
  "statusCheckDelay": 3600
}
```
```

--------------------------------

### Get Recurring Request Status API URL

Source: https://developer.apple.com/documentation/accountdatatransfer/get-recurring-request-status

Use this URL to retrieve the status of a recurring download request. Replace placeholders with your actual request IDs.

```http
GET https://accountdatatransfer.apple.com/api/transfer/accountdata/{parentRequestId}/{requestId}
```

--------------------------------

### Get Request Status API

Source: https://developer.apple.com/documentation/AccountDataTransfer

Retrieves the status of a submitted data request. Use the appropriate endpoint for one-time or recurring requests.

```APIDOC
## 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.

### Get one-time request status
Find the status of a one-time download request.

### Method
GET

### Endpoint
`/path/to/request/status/{requestId}`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The identifier of the request.

### Response
#### Success Response (200)
- **RequestStatus** (object) - An object that represents the status of a download request.
  - **status** (string) - The current status of the request (e.g., `completed`, `completed_with_error`, `pending`).

#### Response Example
```json
{
  "status": "completed"
}
```

---

### Get recurring request status
Get the status of an instance of a recurring download request.

### Method
GET

### Endpoint
`/path/to/recurring/request/status/{requestId}`

### Parameters
#### Path Parameters
- **requestId** (string) - Required - The identifier of the request.

### Response
#### Success Response (200)
- **RequestStatus** (object) - An object that represents the status of a download request.
  - **status** (string) - The current status of the request (e.g., `completed`, `completed_with_error`, `pending`).

#### Response Example
```json
{
  "status": "completed"
}
```
```

--------------------------------

### Request a One-Time Download

Source: https://developer.apple.com/documentation/accountdatatransfer/submit-request

Initiates a single data download request using the curl command and shows the corresponding JSON response.

```curl
% curl -X POST \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "ONE_TIME" }' \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/submit
```

```json
{
  "requestId": "11619695-72C0-4FFD-858A-1E152DCF0838",
  "status": "in_progress",
  "statusCheckDelay": 86400
}
```

--------------------------------

### Successful Response for Recurring Download URLs

Source: https://developer.apple.com/documentation/accountdatatransfer/get-recurring-request-download-urls

This JSON structure represents a successful response from the API, containing a list of asset URLs and the job status. The `assetInfo` array lists the download links, and `jobStatus` indicates the completion state.

```json
{
  "assetInfo": [
    "https://assets.example.com/1.zip",
    "https://assets.example.com/2.zip"
  ],
  "jobStatus": "completed",
  "status": "success"
}

```

--------------------------------

### DownloadLinks response structure

Source: https://developer.apple.com/documentation/accountdatatransfer/get-one-time-request-download-urls

The JSON response body containing asset URLs and the current job status.

```json
{
  "assetInfo": [
    "https://assets.example.com/1.zip",
    "https://assets.example.com/2.zip"
  ],
  "jobStatus": "completed",
  "status": "success",
}
```

--------------------------------

### Request a Recurring Download

Source: https://developer.apple.com/documentation/accountdatatransfer/submit-request

Initiates a recurring data download request using the curl command and shows the corresponding JSON response.

```curl
% curl -X POST \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Content-Type: application/json" \
  -d '{ "mode": "DAILY_30" }' \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/submit
```

```json
{
  "parentRequestId": "EABD06C0-9210-47FF-83C4-318CF8520644",
  "requestId": "7BBBD45D-638B-4DB5-8B02-F23FDB15EDA7",
  "status": "in_progress",
  "statusCheckDelay": 86400
}
```

--------------------------------

### Submit Request API

Source: https://developer.apple.com/documentation/AccountDataTransfer

Submits a request to prepare user data for download. Supports one-time and recurring requests.

```APIDOC
## Submit request
Starts preparing someone’s data for download.

### Method
POST

### Endpoint
`/path/to/submit/request`

### Parameters
#### Request Body
- **mode** (string) - Required - Specifies the type of request. Use `ONE_TIME` for a one-time request. For recurring requests, use `DAILY_30` or `WEEKLY_180`.

### Request Example
```json
{
  "mode": "ONE_TIME"
}
```

### Response
#### Success Response (200)
- **CreatedJob** (object) - An object that represents a newly created download request.
  - **requestId** (string) - The unique identifier for the submitted request.
  - **statusCheckDelay** (integer) - The number of seconds to wait before checking the request status.

#### Response Example
```json
{
  "requestId": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "statusCheckDelay": 60
}
```
```

--------------------------------

### Cancel One-Time Download Request

Source: https://developer.apple.com/documentation/accountdatatransfer/cancel-request

Use this cURL command to stop a one-time account data download. Ensure you replace [ACCESS_TOKEN] with your valid token and provide the correct requestId.

```bash
% curl -X POST \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Content-Type: application/json" \
  -d '{ "requestId": "11619695-72C0-4FFD-858A-1E152DCF0838" }' \
  https://accountdatatransfer.apple.com/api/transfer/accountdata/cancel
```

```json
{
  "jobStatus": "cancelled",
  "status": "success"
}
```

--------------------------------

### RequestStatus Object

Source: https://developer.apple.com/documentation/accountdatatransfer/requeststatus

The RequestStatus object provides information about the state of a data download request.

```APIDOC
## RequestStatus Object

An object that represents the status of a download request.

### Properties
- **jobStatus** (string) - The status of the download request. Possible Values: `completed, request_not_found, in_progress, error, completed_with_error, cancelled`
- **status** (string) - `success` if the operation succeeded; `error` otherwise.
- **statusCheckDelay** (integer) - The number of seconds to wait before re-requesting the status.
```

--------------------------------

### DownloadLinks Object

Source: https://developer.apple.com/documentation/accountdatatransfer/downloadlinks

Details regarding the DownloadLinks object structure and its properties for account data retrieval.

```APIDOC
## DownloadLinks Object

### Description
An object that contains URLs to download someone’s account data.

### Properties
- **assetInfo** (array of strings) - An array of URLs to which you make GET requests to download someone’s account data if jobStatus is completed.
- **jobStatus** (string) - The result of the download request. Possible values: completed, request_not_found, in_progress, error, completed_with_error, cancelled.
- **status** (string) - The result of the operation to request download links. Value: success.

### Overview
The URLs provided in the assetInfo property are valid for 15 minutes after they are received.
```

--------------------------------

### POST /resubmit-request

Source: https://developer.apple.com/documentation/accountdatatransfer

Enqueues the next instance of a recurring request.

```APIDOC
## POST /resubmit-request

### Description
Add the next instance of a recurring request to the queue.

### Method
POST

### Endpoint
/resubmit-request

### Parameters
#### Request Body
- **parentRequestId** (string) - Required - The parent identifier for the series.
- **requestId** (string) - Required - The identifier of the most recent instance.
```

--------------------------------

### CreatedJob Object

Source: https://developer.apple.com/documentation/accountdatatransfer/createdjob

Details regarding the CreatedJob object returned upon successful request submission.

```APIDOC
## CreatedJob Object

### Description
An object that represents a newly created download request.

### Properties
- **parentRequestId** (string) - For recurring requests, a UUID that identifies the series of requests. For one-time requests, the server doesn’t include this key in the response.
- **requestId** (string) - A UUID that identifies this request.
- **status** (string) - 'success' if the server created the request; 'error' otherwise.
- **statusCheckDelay** (integer) - The number of seconds to wait before you call 'Get recurring request status' or 'Get one-time request status'.
```

--------------------------------

### HTTP Headers for Data Transfer

Source: https://developer.apple.com/documentation/AccountDataTransfer

Required HTTP headers for making requests to the Apple Account Data Transfer API.

```APIDOC
## 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.
```

--------------------------------

### DownloadError Object

Source: https://developer.apple.com/documentation/accountdatatransfer/downloaderror

Describes an error the server encounters when preparing download URLs for an account data transfer request.

```APIDOC
## Object: DownloadError

An object that describes an error the server encounters preparing download URLs for a request.

**Applies to:** Account Data Transfer 1.0+

### Properties

*   **`statusCheckDelay`** (integer)
    The number of seconds to wait before re-requesting the status.

*   **`status`** (string)
    The outcome of the operation. Must be `error`.

*   **`statusMessage`** (string)
    The reason the server encountered an error. Possible values include: `in_progress`, `request_not_found`, `invalid_request_status`.

### Overview of `statusMessage` Values

*   **`invalid_request_status`**
    The download request isn’t complete. You need to request the download URLs again after `statusCheckDelay` seconds.

*   **`request_not_found`**
    The request ID you provided isn’t recognized.

### See Also

*   [Downloads](https://developer.apple.com/documentation/accountdatatransfer/downloads)
    *   `Get one-time request download URLs`
    *   `Get recurring request download URLs`
*   `object DownloadLinks`
```

--------------------------------

### CancellationResponse Object

Source: https://developer.apple.com/documentation/accountdatatransfer/cancellationresponse

Describes the outcome of canceling a download request in the Account Data Transfer API.

```APIDOC
## CancellationResponse

### Description
An object that describes the outcome of canceling a download request.

### Properties
- **jobStatus** (string) - The current status of the download request. Value: "cancelled".
- **status** (string) - The outcome of the cancellation operation. Possible Values: "success", "error".
```

--------------------------------

### Submit Request Endpoint URL

Source: https://developer.apple.com/documentation/accountdatatransfer/submit-request

The base URL for the account data transfer submission endpoint.

```http
POST https://accountdatatransfer.apple.com/api/transfer/accountdata/submit
```

--------------------------------

### ResubmissionRequest Object

Source: https://developer.apple.com/documentation/accountdatatransfer/resubmissionrequest

Defines the structure and properties of a request to resubmit a recurring download request.

```APIDOC
## ResubmissionRequest Object

### Description
An object that describes a request to resubmit a recurring download request.

### Properties
- **parentRequestId** (string) - A UUID that identifies the recurring request series.
- **requestId** (string) - A UUID that identifies the most recent download request in the recurring series.

### Usage
Use the `parentRequestId` and `requestId` returned by `Submit request`, or your most recent call to `Resubmit request`.
```

--------------------------------

### Define ResubmissionRequest Object

Source: https://developer.apple.com/documentation/accountdatatransfer/resubmissionrequest

Defines the structure of the ResubmissionRequest object. Use this object to describe a request to resubmit a recurring download request.

```swift
object ResubmissionRequest
```

--------------------------------

### JobSubmission Object

Source: https://developer.apple.com/documentation/accountdatatransfer/jobsubmission

Details regarding the JobSubmission object structure and its properties.

```APIDOC
## JobSubmission Object

### Description
An object that describes a submission that requests someone’s data.

### Properties
- **mode** (string) - Whether you want a one-time download, a daily download for 30 days, or a weekly download for 180 days. Possible Values: `ONE_TIME`, `DAILY_30`, `WEEKLY_180`
```

--------------------------------

### CancellationRequest Object

Source: https://developer.apple.com/documentation/accountdatatransfer/cancellationrequest

Defines the structure of a cancellation request for the Account Data Transfer API.

```APIDOC
## CancellationRequest Object

### Description
An object that identifies a one-time request, or an individual instance of a recurring request, to cancel.

### Properties
- **requestId** (string) - Required - An identifier for the request to cancel. For a one-time request, use the request’s UUID. For a recurring request, use the parentRequest’s UUID.
```

--------------------------------

### Cancel Recurring Download Request

Source: https://developer.apple.com/documentation/accountdatatransfer/cancel-request

This cURL command is used to cancel a recurring account data transfer. Provide your access token and the specific requestId for the recurring job.

```bash
% curl -X POST \
  -H "Authorization: Bearer [ACCESS_TOKEN]" \
  -H "X-Apple-Transaction-Id: E3857B28-7FC4-41C8-AC54-08E121E26F59" \
  -H "Content-Type: application/json" \
  -d '{ "requestId": "7BBBD45D-638B-4DB5-8B02-F23FDB15EDA7" }' \
  https://accountdatatransfer.apple.com/api/transfer/accountadata/cancel
```

```json
{
  "jobStatus": "cancelled",
  "status": "success"
}
```

--------------------------------

### POST /cancel

Source: https://developer.apple.com/documentation/accountdatatransfer

Endpoint to stop processing an active data transfer request.

```APIDOC
## POST /cancel

### Description
Tells the server to stop processing an active request.

### Method
POST

### Endpoint
/cancel

### Request Body
- **CancellationRequest** (object) - Required - An object that identifies a one-time request, or an individual instance of a recurring request, to cancel.

### Response
#### Success Response (200)
- **CancellationResponse** (object) - An object that describes the outcome of canceling a download request.
```

--------------------------------

### POST /api/transfer/accountdata/resubmit

Source: https://developer.apple.com/documentation/accountdatatransfer/resubmit-request

Enqueues the next instance of a recurring request. The requestId provided must be the most recent instance of the series identified by the parentRequestId.

```APIDOC
## POST /api/transfer/accountdata/resubmit

### Description
Enqueue the next instance of a recurring request. The requestId you pass must be the most recent instance of the series identified by the parentRequestId.

### Method
POST

### Endpoint
https://accountdatatransfer.apple.com/api/transfer/accountdata/resubmit

### Request Body
- **parentRequestId** (string) - Required - The identifier for the recurring request series.
- **requestId** (string) - Required - The identifier for the most recent instance of the series.

### Request Example
{
  "parentRequestId": "EABD06C0-9210-47FF-83C4-318CF8520644",
  "requestId": "7BBBD45D-638B-4DB5-8B02-F23FDB15EDA7"
}

### Response
#### Success Response (200)
- **parentRequestId** (string) - The identifier for the recurring request series.
- **requestId** (string) - The identifier for the newly resubmitted instance.
- **status** (string) - The status of the request.
- **statusCheckDelay** (integer) - The delay in seconds before checking the status.

#### Response Example
{
  "parentRequestId": "EABD06C0-9210-47FF-83C4-318CF8520644",
  "requestId": "A2DFE115-F039-4FC4-8286-7EAD51D91D8B",
  "status": "success",
  "statusCheckDelay": 86400
}
```

--------------------------------

### CancellationRequest Object Definition

Source: https://developer.apple.com/documentation/accountdatatransfer/cancellationrequest

The object definition for a cancellation request in the Account Data Transfer API.

```text
object CancellationRequest
```

--------------------------------

### ResubmissionResponse Object

Source: https://developer.apple.com/documentation/accountdatatransfer/resubmissionresponse

Details about the ResubmissionResponse object, including its properties and their types.

```APIDOC
## ResubmissionResponse

An object that represents a resubmitted recurring download request.

Account Data Transfer 1.0+

```
object ResubmissionResponse
```

### Properties

`parentRequestId`
(string) - A UUID that identifies the recurring request series.

`requestId`
(string) - A UUID that identifies the new request.

`status`
(string) - `success` if the server resubmitted the request; `error` otherwise.

`statusCheckDelay`
(integer) - The number of seconds to wait before you call `Get recurring request status`.
```

--------------------------------

### Resubmission Response JSON

Source: https://developer.apple.com/documentation/accountdatatransfer/resubmit-request

The JSON structure returned upon a successful resubmission request.

```json
{
  "parentRequestId": "EABD06C0-9210-47FF-83C4-318CF8520644",
  "requestId": "A2DFE115-F039-4FC4-8286-7EAD51D91D8B",
  "status": "success",
  "statusCheckDelay": 86400
}
```

--------------------------------

### POST /api/transfer/accountdata/cancel

Source: https://developer.apple.com/documentation/accountdatatransfer/cancel-request

This endpoint allows you to stop an active account data transfer request. The cancellation is only successful if the request is currently in progress.

```APIDOC
## POST /api/transfer/accountdata/cancel

### Description
Tells the server to stop processing an active request.

### Method
POST

### Endpoint
https://accountdatatransfer.apple.com/api/transfer/accountdata/cancel

### Parameters
#### Request Body
- **requestId** (string) - Required - An identifier for the request to cancel.

### Request Example
```json
{
  "requestId": "11619695-72C0-4FFD-858A-1E152DCF0838"
}
```

### Response
#### Success Response (200 OK)
- **jobStatus** (string) - The status of the job, expected to be "cancelled".
- **status** (string) - The overall status of the operation, expected to be "success".

#### Response Example
```json
{
  "jobStatus": "cancelled",
  "status": "success"
}
```

#### Error Responses
- **400 Bad Request**: Bad Request
- **401 Unauthorized**: Unauthorized
- **403 Forbidden**: Forbidden
- **500 Internal Server Error**: Internal Server Error
```

--------------------------------

### Resubmit Request Endpoint URL

Source: https://developer.apple.com/documentation/accountdatatransfer/resubmit-request

The POST endpoint for resubmitting a recurring data transfer request.

```http
POST https://accountdatatransfer.apple.com/api/transfer/accountdata/resubmit
```

--------------------------------

### Cancel Request Operation

Source: https://developer.apple.com/documentation/accountdatatransfer/cancellationrequest

Initiates the cancellation of an active request within the Account Data Transfer API.

```APIDOC
## POST /accountdatatransfer/cancel

### Description
Tells the server to stop processing an active request.

### Method
POST

### Endpoint
/accountdatatransfer/cancel

### Request Body
- **requestId** (string) - Required - An identifier for the request to cancel. For a one-time request, use the request’s UUID. For a recurring request, use the parentRequest’s UUID.

### Response
#### Success Response (200)
- **status** (string) - Indicates the outcome of the cancellation request (e.g., "success", "failed").
- **message** (string) - Provides details about the cancellation operation.
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.