Create a privacy request

POST 
/api/v1/privacy_requests

Create a privacy request

Request

Header Parameters

authorization stringrequired
Example: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9

application/json

Body

privacy_right stringrequired

access, access_categories, or deletion

identifiers objectrequired

JSON object that contains values used to identify personal data. Supports an array with a single email

custom object

JSON object containing any custom data associated with the privacy request. Values can be strings, numbers, arrays, booleans, or null.

Responses

200

Privacy Request created

application/json

Schema

Schema

custom object
identifiers object

The email of the data subject

privacy_right string

The type of request that was made.

status string

The status of the request.

id string

The unique identifier of the request.

Example (from schema)

{
  "custom": {
    "first_name": "Queen",
    "last_name": "Guinevere",
    "country": "Britain",
    "app_id": "holy_grail_app",
    "origin": "iOS"
  },
  "identifiers": {
    "email": [
      "guinevere@camelotknights.com"
    ]
  },
  "privacy_right": "deletion",
  "status": "open",
  "id": "967e34da-4863-4fcf-842d-176dd102d032"
}

422

Invalid Request

Loading...