Inactivate person

Person inactivation is used when your customer ends the business relationship and prefers not to retain an active status.

The person inactivation consists of the following steps:

1. Start person inactivation,

2. View process status.

Start inactivation process

Call the person inactivation API endpoint to start the process of setting the person's record to an INACTIVE status.

This action is irreversible. Once a person is inactivated, the record cannot be reactivated.

The completed process sets the person's record to an INACTIVE status, but its data remains readable and retrievable.

View process inactivation status

Once the inactivation process is initiated, you can monitor its status through the find person processes endpoint.

The processStatusCode will indicate one of the following statuses:

• STARTED: the inactivation has started and is ongoing.

• FINISHED: the final process status, indicating that the inactivation was successfully completed. The person's record has INACTIVE status.

• FAILED: the final process status, indicating that the inactivation was interrupted as incomplete. The person's record remains in ACTIVE status.

Recommended failover actions

If the person's inactivation processStatusCode is marked as FAILED, check the processStatusReasonCodes to identify the cause of the failure. Common reasons for inactivation failure include open service contracts like cards, loans, or accounts.

Make sure all person-related contracts are closed and all activities completed. Once you have addressed these issues, you can start the new inactivation process for the person.

Sample API calls

To view the sample API call of person inactivation, refer to the following example in the API cookbook.