All pages
Powered by GitBook
1 of 1

Loading...

Forget person

Use case

In this use case, we will review a situation when a person - Rhys Davey with personId ID-3204, who has the account inactivated, requested the bank to remove the personal data. To complete this request, you can initiate the forget person process.

Sample API call

To initiate the forget person process, make the following API call.

Sample request

Below is an example request body of the forget person API call.

{
  "processReason": "CUSTOMER_REQUESTED",
  "processDate": "2023-06-15"
}
curl -X 'POST' \
  'https://person-api.dev.tuum.xyz/api/v1/persons/ID-3204/forget/start' \
  -H 'accept: */*' \
  -H 'x-channel-code: SYSTEM' \
  -H 'x-tenant-code: MB.EU' \
  -H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjc3JmVG9rZW4iOiJzdHJpbmciLCJleHBpcnlEVGltZSI6IjIwMjMtMDYtMTZUMTg6NDg6NDQiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIuRVUiLCJleHAiOjE2ODY5NDEzMjR9.OBniiwiaI2ZN1PMdr6InOjUNtg22vEso8wnpV6kJ104' \
  -H 'Content-Type: application/json' \
  -d '{
  "processReason": "CUSTOMER_REQUESTED",
  "processDate": "2023-06-15"
}'

Sample response

The forget person generates the following response.

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

Result

As an outcome, the personal data of Rhys Davey ID-3204 is forgotten.

https://person-api.sandbox.tuumplatform.com/api/v1/persons/ID-3204/forget/start

Learn more about the endpoint in the Tuum developer portal.

forget person