Inactivate person

Use case

Here, you can learn how to inactivate a person who is no longer an active user. We will inactivate a private person, Rhys Davey, who no longer uses any services and does not wish to maintain an active customer record.

Use case data	API parameters with values
The personId of Rhys Davey who we want to inactivate isID-3204.	.../persons/ID-3204/inactivate/start
Since the person requested to inactivate their account, the reason can be set as OTHER.	"processReason": "OTHER"
The inactivation is effective from June 15th 2023. The date format: YYYY-MM-DD.	"processDate": "2023-06-15"

Person inactivation is not permanent and person can be reactivated to PENDING status and later activated to ACTIVE status.

You can use different values for the processReason parameter. See below:

Private person

The processReason for private person:

• MERGER,

• DEATH,

• OTHER,

• LEFT_FOR_COMPETITOR,

• DATA_RETENTION_PERIOD_END.

Legal person

The processReason for legal person:

• MERGER,

• LIQUIDATION,

• OTHER,

• LEFT_FOR_COMPETITOR,

• DATA_RETENTION_PERIOD_END.

Sample API call

To inactivate a person, make the following API call.

https://person-api.sandbox.tuumplatform.com/api/v2/persons/ID-3204/inactivate/start

Learn more about the inactivate person endpoint in the Tuum developer portal.

Sample request

Below is an example request body of the API call to inactivate a person.

JSON

{
  "processReason": "OTHER",
  "processDate": "2023-06-15"
}

cURL

curl --location 'https://person-api.sandbox.tuumplatform.com/api/v2/persons/ID-3204/inactivate/start' \
--header 'x-channel-code: system' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDYtMTVUMTQ6MTc6MTgiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODY4Mzg2Mzh9.nohgrCBeB0UK4HVFLGlV867_C923zuMe_m_Y6I6Jl8k' \
--header 'Content-Type: application/json' \
--data '{
  "processReason": "OTHER",
  "processDate": "2023-06-15"
}'

Sample response

Below you find an example response body to the API call above.

Response

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

Result

The person's status is changed to INACTIVE.