Right to Forget API
The API generates a unique request-id and launches the async deletion operation of the MongoDB collections.
Endpoint
Method: DELETE
URL: data/customer/{customer-id}
Request
curl -H "nonce-token: hYuDOuy8X0li8ZGBNPITakAtpi5tQ8ZY/rQ8GiAWfPc=" -H "Authorization: Bearer 911999706310ffbcb32981863e23ce72d5e60d7b" -XDELETE https://api.{region}.cloud.uniphore.com/config/backend/v2/data/customer/{customer-id}
Header Parameters
Header Parameters | Description |
|---|---|
| Bearer <Token> is used to authenticate this API. The access token should be sent with all client requests. The access token helps the server to validate the request source. |
| nonce token is used to protect API from data reply attacks. Whenever a delete request is sent, we should send a new nonce token. The nonce token can be obtained through GET nonce token API. |
For details on fetching nonce token, click here.
Path Parameter
Path Parameter | Description |
|---|---|
| ID of the customer whose PII needs to be deleted from the mongo database collection. The customer id can be extracted from the audio logger/connector. The procedure to collect the customer id is defined in the Admin guide under the section Extract Customer id from Audio Logger/Connector. |
Example Response
{
"data": {
"requestId": "12121212",
"startTime": 121212121,
"status": "in-progress",
"userId": 1
}
}
Response Parameters
Response Parameters | Description |
|---|---|
| A unique id for the delete request |
| Start time of the delete request placed |
| Status of the delete request. The status can be:
|
| The Id of the user whose PII need to be deleted. The customer-id in the request and userId in the response are the same. |
Response and Error Codes
Response and Error Code | Description |
|---|---|
200 | The delete request is processed and display the above given response. |
401 | Authentication failed |
404 | Invalid customer-id |
500 | Internal server error |