v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Data Privacy

Download requested data

Retrieve the customer data from a previously submitted privacy request for data access.

get/privacy/requests/{id}/data

Path parameters

idstring required

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.

Response

Example privacyDownloadResponse

addressesGeneralPayloadMap[] required

List of known addresses.

emailsGeneralPayloadMap[] required

List of known email addresses.

ipsGeneralPayloadMap[] required

List of known IP addresses.

phonesGeneralPayloadMap[] required

List of known phone numbers.

requestsGeneralPayloadMap[] required

List of objects that represent requests sent to Forter.

Example response

{
  "addresses": [],
  "emails": [],
  "ips": [],
  "phones": [],
  "requests": []
}