Overview

---

The Privacy Requests API allows partners to automate the processing of consumers’ Data Subject Access Requests related to data stored by ID5. The Data Deletion service handles deletion of any data associated with the consumer, if any.

1. The first step is to POST the Data Deletion Request with the necessary information for ID5 to process it.
2. The response to this request will contain a job ID that can then be queried using the Status API to see the status of the request.

Data Deletion Request

---

Example URL

https://api.id5-sync.com/partners/v1/{PARTNER}/privacy/requests/deletion?token={TOKEN}

Request Type

HTTP POST with JSON body

Request Headers

Content-Type: application/json; charset=UTF-8

Partner Number

The value {PARTNER} in the above example url will be replaced by an ID5-provided Partner Number. This value will be static for you once we set you up in our system. You may use the example URL above during testing with the Partner Number 173. If you haven't already been assigned a Partner Number, please contact us to request one.

Available Parameters

Querystring

Request Body

Possible jurisdiction values

• GDPR
• CCPA

Example Data Deletion Request

POST: https://api.id5-sync.com/partners/v1/173/privacy/requests/deletion?token=abc123

{
   "email": "cd372fb85148700fa88095e3492d3f9f5beb43e555e5ff26d95f5a6adc36f8e6",
   "id5id": "ID5*j0EDhnOeLA7GJ9KXt05cszkCOLRHRyqVRKNx4Wo9iEtZYPIcnd32YHQ9MjAOLR0UWWEhBhCvzGoO5pggW2pX3w",
   "maid": "580d2b4c-29a5-7a7b-85dc-44132c023ac8",
   "partnerUid": "a-123456789",
   "jurisdiction": "GDPR",
   "replyToEmail": "[email protected]"
}

Data Deletion Response

---

Successful Response

HTTP Status Code

200 OK

Response Body

Example Successful Response

{
  "id": "a8b6ccc4ee35ddaf5a5bb0f5c696dbd3"
}

Unsuccessful Response

Schema

{
  "error": {
    "code": "{CODE}",
    "type": "{TYPE}"
    "message": "{MESSAGE}",
  }
}

Error Descriptions

Example Unsuccessful Response

{
  "error": {
    "code": "api_token_invalid",
    "type": "authentication_error"
    "message": "No API token provided",
  }
}

Status Request

---

Example URL

https://api.id5-sync.com/partners/v1/{PARTNER}/privacy/requests/{PRIVACY_REQUEST_DELETION_JOB_ID}?token={TOKEN}

Request Type

HTTP GET

Available Parameters

URL Path

Querystring

Example Request

POST: https://api.id5-sync.com/partners/v1/173/privacy/requests/a8b6ccc4ee35ddaf5a5bb0f5c696dbd3?token=abc123

Status Response

---

Successful Response

HTTP Status Code

200 OK

Response Body

Possible jobStatus values

• CREATED
• STARTED
• FAILED
• DONE
• SENT
• SEND_FAILED
• CANCELLED

Possible processingResult values

• DELETE_DELETED
• DELETE_NO_DATA
• NONE

Example Successful Response

{
   "id": "a8b6ccc4ee35ddaf5a5bb0f5c696dbd3",
   "jobStatus": "SENT",
   "processingResult": "DELETE_DELETED",
   "emailSentUnixTimestamp": 1661933465437
}

Unsuccessful Response

Schema

{
  "error": {
    "code": "{CODE}",
    "type": "{TYPE}"
    "message": "{MESSAGE}",
  }
}

Error Descriptions

Example Unsuccessful Response

{
    "error": {
        "code": "user_object_invalid",
        "message": "provided job UUID not found",
        "type": "invalid_request_error"
    }
}