Manual Privacy Requests
Manual privacy requests are a simple way for data to be manually uploaded for an access request. Erasure requests are not supported at this time. Manual privacy requests gather data outside of the graph as a first step, and are similar to privacy request webhooks.
If you have manual privacy requests defined, privacy request execution will exit early and remain in a state of requires_input.
Once data has been manually uploaded for all the manual privacy requests, then the privacy request can be resumed. Data uploaded for manual privacy requests is passed on directly to the data subject alongside the data package. It is not filtered on data category. Any manual data uploaded is passed on as-is.
Configuration
Create a connection config of type manual_webhook
[
{
"name": "Manual privacy request ConnectionConfig",
"key": "manual_webhook_key",
"connection_type": "manual_webhook",
"access": "read"
}
]| Field | Description |
|---|---|
key | Optional. A unique key used to manage your connection config. This is auto-generated from name if left blank. Accepted values are alphanumeric, _, and .. |
name | A unique user-friendly name for your connection config. This key will also be used to identity the manual request |
connection_type | Should be manual_webhook for the resource described here. |
access | One of read or write |
Define the fields expected for your manual_webhook
Submit a list of fields that will need to be manually uploaded.
{
"fields": [
{"pii_field": "First Name", "dsr_package_label": "first_name"},
{"pii_field": "Last Name", "dsr_package_label": "last_name"},
{"pii_field": "Phone Number", "dsr_package_label": null},
{"pii_field": "Height", "dsr_package_label": "height"}
]
}| Field | Description |
|---|---|
fields | Required. A list of field mappings with pii_field and dsr_package_label keys. The pii_field is the label Fides will display when it solicits manual input, and the dsr_package_label is the identifier Fides will use when it uploads the data to the data subject. If no dsr_package_label is supplied, it will be created from the pii_field. |
Upload manual request data for a given privacy request
Privacy request execution will exit early with a status of requires_input if we're missing data for manual_webhook. This will prompt a form in the Fides Admin UI to be filled out after approving the request.
Additionally, manual input data can be provided via the API. A request will need to be made for each manual_webhook to upload the requested data before request execution can proceed.
Note that the fields here are dynamic and should match the fields specified on the manual request. All fields are optional. If no data exists, an empty dictionary should be uploaded. Fides treats this upload as confirmation that the system was searched for data related to the data subject.
{
"first_name": "Jane", // The key here is the dsr_package_label from the manual request
"last_name": "Customer"
}Resume Privacy Request Execution
Once a PrivacyRequest with requires_input has had all of its manual data uploaded, prompt the privacy request to resume by executing:
POST /api/v1/privacy-request/{{privacy_request_id}}/resume_from_requires_input