All pages
Powered by GitBook
1 of 1

Loading...

Remove person restoration key

Use case

In this example, we will review how to forget a person record forever and make it unrecoverable.

Use case data
API parameters with values

There is a private person personId ID-3415 whose person record is already inactivated and forgotten. The person wants to ensure that the personal data is removed completely and is non-recoverable.

...persons/ID-3415/forget/key

Sample API call

To remove the restoration key, make the following call.

Sample request

Below is an example request to remove the restoration key call.

No request body.

curl -L -X DELETE 'https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-3415/forget/keyhttps://person-api.{{env}}.{{domain}}/api/v1/persons/ID-3415/forget/key' \
-H 'x-channel-code: BACKOFFICE' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMTJUMTQ6MDg6MTYiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODkxNzA4OTZ9.Weps_UVn2b2iOkcZYgSyZd_mcxu7TSoOVxABvDWsWkI' \
-d '{
  "processReason": "OTHER",
  "processDate": "2023-06-15"
}'

Sample response

The remove restoration key endpoint generates the following response.

Response
{
    "errors": null,
    "validationErrors": null,
    "data": null
}

Result

The restoration key of a forgotten person ID-3415 is removed. The personal data that belong to the person is non-recoverable.

https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-3415/forget/key

See more about the endpoint in the Tuum developer portal.

remove person restoration key