Reactivate person

Use case

Here, you can learn how to reactivate a person who is in INACTIVE status. We will reactivate a private person, Rhys Davey, who was inactivated previously, but has now returned as a client.

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

You can use different values for the processReason parameter, which can be defined from Lookups.

The by default processReason-s for private and legal persons:

• ERROR,

• OTHER.

Sample API call

To reactivate a person, make the following API call.

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

Learn more about the reactivate 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/v1/persons/ID-3204/reactivate/start' \
--header 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJuYW1lIjoiTGF1cmEgVCIsImVtcGxveWVlSWQiOiJJRC0xMDU0IiwidGVuYW50Q29kZSI6Ik1CIiwiZXhwaXJ5RFRpbWUiOiIyMDI1LTAzLTA1VDE1OjEwOjE4IiwiZXhwIjoxNzQxMTg3NDE4LCJyb2xlcyI6WyJBRE1JTiJdfQ.gnVRav5NmpZapS3uGMLt69xADsYdEPiGGOjXnt1jqyY' \
--header 'x-channel-code: SYSTEM' \
--header 'Accept-Language: en' \
--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 PENDING. The person can be activated with 'Activate person' endpoint.