Vidyard-GDPR Request API
The Vidyard GDPR Request API is a micro service that allows you to programatically manage your compliance with Europe's General Data Protection Regulation (GDPR).
The API allows you to make access
, rectify
, and forget
requests against Vidyard's database to comply with a data-subject's right to obtain, revise or delete information that you have gathered about them through your services, website, technology, etc.
The API requires that you have an webhook URL that allows your application to accept responses in JSON format.
Requirements
- You will require a Vidyard API token to make requests
Submit a request
Make a POST request to https://api.vidyard.com/dashboard/v1/gdpr_requests
Each POST request must include an action, the data subject's email address, your Vidyard API token, and the webhook URL that will receive a response from the API.
request_action
must specific one of the following values:
-
Access:
receive a JSON file that contains data about the subject from Vidyard -
Forget:
delete all data that Vidyard has associated with a person's email address -
Rectify:
update data associated with a person's email address. You must specifynew_values
for at least one piece of information: email, first name, last name, or company.
{
"request_action": "rectify",
"email": "nancy.drew@vidyard.com",
"auth_token": "your Vidyard API token",
"webhook": "your application webhook URL",
"new_values": {
"email": "ndrew@vidyard.com",
"first_name": "Nancy",
"last_name": "Drew",
"company": "Drew Investigations"
}
}
Example response
Upon a successful request (202 status), you'll receive a synchronous response with a unique receipt_id
.
A response will also be delivered to your webhook URL containing the request_action
, a matching receipt_id
, and the date and time that the request was completed.
Access
requests will also return a JSON file containing data that Vidyard has associated with the subject's email address. The download URL for the file expires after 7 days.
{ "action": "access", "receiptId": "my-receipt-id", "completedAt": "2019-12-09T16:05:08.629Z", "data": "https://vy-gdpr-production.s3.amazonaws.com/final/my-receipt-id.json?AWSAccessKeyId=accesskey"
}