Sign in

v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Data Privacy

Privacy request

In compliance with privacy laws, request access or deletion of customer data on behalf of the customer. This endpoint should only be used if a data subject has specifically asked that their personal data be accessed or deleted, and their identity has been verified. The response will include a unique ID assigned to this request.

post/privacy/requests

Headers

api-versionstring required
Example:10.1

Specify the version of the API to target.

x-forter-siteidstring required
Example:a1b2c3d4e5f6

Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Authorizationstring required
Example:Basic <base64-encoded-api-key:>

Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.

Request body

requestType'DELETE' | 'ACCESS' required

Type of this privacy request

Example request

{
  "identifier": {
    "type": "EMAIL",
    "value": "user@test.com"
  },
  "requestType": "ACCESS"
}

Response

Example privacyResponse

requestUniqueIdstring required

A Forter unique identifier that was assigned to a privacy request. It can be used to retrieve the status information and download the output data in case of an access request.

Example response

{
  "requestUniqueId": "2023-04-23T060200931-ax32-privacy"
}