Requests
A Requests refers to a Data Subject Request that is a important facet of privacy laws like GDRP in Europe or CPRA in California. Most of the privacy laws give certain data rights to consumers like right of access or deletion.
The /dsar/requests
endpoint of the API exposes the requests
managed by Didomi for your organization. For a full reference of the endpoint and the resources that it returns, visit https://api.didomi.io/docs/.
Create a Request
When end-users want to express one of their rights, you can create a request to register the end-user application by calling the endpoint POST /dsar/requests
.
Entity | Type | Mandatory | Description |
---|---|---|---|
| String | Yes | ID of your end-user. An email is recommended so our system can send emails to your end-users each time you change the request status. |
| Enum | Yes | ID of the User Right activated by the end-user. Value should be of the following |
| Enum | Yes | Status of the Privacy Request. Status can be either |
| Array | No | Group of additional fields that can be requested to the end-user to submit a Privacy Request. Includes |
| String | Yes | Type of widget from which the request has been created (for a privacy request, type will always be |
Country
When a privacy request is created from a Privacy request widget, our SDK will apply the end-user location to the created request. You can reproduce the same workflow when using Didomi API by setting the country
property either in user
or source
entity.
Property | Type | Mandatory | Description |
---|---|---|---|
| String | No | It corresponds to the user country. If the user does not exist yet in Didomi DB, we will create it and apply the value of |
| String | No | It corresponds to the country from where the request has been formulated. You can attach a country to a request by setting |
Create a Request with approval workflow
Didomi supports email approval method where a request needs to be approved before being considered as verified
. To require identity confirmation, you can set the status to unverified
and this will send an email to the user after he submitted the request.
To create a request with approval workflow, you can send a POST request on /dsar/requests
and set the status to unverified
.
Update a Request
You can update requests in order to match the actual state of the request within your processing workflow or to attach further information to your request.
To update request, you can send a PATCH request on /dsar/requests/{id}
.
💡 When updating a request, we authorized edition only for status
, metadata
and extra_message_variables
properties.
Provide a download link to your end-user by filling in the property download_link
while you are updating the status of a data access request to fulfilled
.
Query a list of Requests
To fetch the list of Privacy Requests of your organization, you can send a GET request on https://api.didomi.io/dsar/requests
.
You can also query a specific request by ID. To fetch a request, you can send a GET request on https://api.didomi.io/dsar/requests/{{id}}
.
Last updated