プライバシーリクエスト

POST

https://api.forter-secure.com/privacy/requests

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.

Header Parameters

api-versionstringrequired
Example
10.1
Description
Specify the version of the API to target.
Default
10.1
x-forter-siteidstringrequired
Example
a1b2c3d4e5f6
Description
Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.
Default
8b47c6d423ba

Body Parameters

bodyprivacyRequestRequestrequired
Description
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.
- identifierIdentifierrequired
  Description
  Request identifier details
  - typestring<EMAIL>required
    Description
    Type of identifier
    Default
    EMAIL
  - valuestringrequired
    Description
    Identifier value
    Default
    [email protected]
- requestTypestring<DELETE | ACCESS>required
  Description
  Type of this privacy request
  Default
  ACCESS

Responses

200Example privacyResponse

privacyResponse
Description
Response object for creation of a new privacy request.
- requestUniqueIdstringrequired
  Description
  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.
  Default
  2023-04-23T060200931-ax32-privacy

400Bad Request (Often missing a required parameter)

401Unauthorized (No valid API key provided)

404Not Found (The requested item doesn't exist)

500Server Error (Something went wrong on Forter's end)

curl

curl --request POST \
     --url https://api.forter-secure.com/privacy/requests \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'api-version: 10.1' \
     --header 'x-forter-siteid: 8b47c6d423ba' \
     --header 'authorization: Basic <base64-encoded-api-key:>' \
     --data-raw '{
     "identifier": {
     "type": "EMAIL",
     "value": "[email protected]"
     },
     "requestType": "ACCESS"
     }'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("api-version", "10.1");
myHeaders.append("x-forter-siteid", "8b47c6d423ba");
myHeaders.append("authorization", "Basic <base64-encoded-api-key:>");

var raw = JSON.stringify({
   "identifier": {
      "type": "EMAIL",
      "value": "[email protected]"
   },
   "requestType": "ACCESS"
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.forter-secure.com/privacy/requests", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.forter-secure.com/privacy/requests")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["api-version"] = "10.1"
request["x-forter-siteid"] = "8b47c6d423ba"
request["authorization"] = "Basic <base64-encoded-api-key:>"
request.body = JSON.dump({
   "identifier": {
      "type": "EMAIL",
      "value": "[email protected]"
   },
   "requestType": "ACCESS"
})

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.forter-secure.com/privacy/requests"

payload = json.dumps({
   "identifier": {
      "type": "EMAIL",
      "value": "[email protected]"
   },
   "requestType": "ACCESS"
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'api-version': '10.1',
   'x-forter-siteid': '8b47c6d423ba',
   'authorization': 'Basic <base64-encoded-api-key:>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Example privacyResponse
{
  "requestUniqueId": ""
}

400

// Bad Request (Often missing a required parameter)

401

// Unauthorized (No valid API key provided)

404

// Not Found (The requested item doesn't exist)

500

// Server Error (Something went wrong on Forter's end)

プライバシー法に従い、顧客の代理として顧客データへのアクセスまたは削除を要求します。このエンドポイントは、データ主体が特に自分の個人データへのアクセスまたは削除を求め、その身元が確認された場合にのみ使用する必要があります。応答には、このリクエストに割り当てられた一意のIDが含まれます。