Download a previously issued data request

GET /requests/{requestId}/download
O auth

When a request is complete, an archive can be downloaded that contains all personal information of the authenticated user. This archive should be a .ZIP file that follows a particular structure. For more info, see the additional documentation linked below.

Path parameters

  • requestId string Required

    A random identifier that uniquely identifies a request. A version 4 UUID is strongly recommended. Note: the generated identifier must be random. The identifier must not include any information that can be related to the requester. Additionally, requestIds must not be incremental.

Responses

  • 200

    OK
  • 400

    Bad Request

    Hide response attributes Show response attributes object
    • error string

      Value is Bad Request.

    • message string

      Value is The request you are trying to retrieve has not been completed yet.
  • 401

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      Value is Unauthorized.

    • message string

      Value is You are not authorized. Generate authentication tokens via OAuth to access this resource..
  • 404

    Not Found

    Hide response attributes Show response attributes object
    • error string

      Value is Not Found.

    • message string

      Value is Could not find a data request with this id..
GET /requests/{requestId}/download 
curl \
 -X GET http://api.example.com/requests/{requestId}/download \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
"@file"
Response examples (200) 
@file
Response examples (400) 
{
  "error": "Bad Request",
  "message": "The request you are trying to retrieve has not been completed yet"
}
Response examples (400) 
{
  "error": "Bad Request",
  "message": "The request you are trying to retrieve has not been completed yet"
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}