GuidesAPI ReferenceChangelog
Log In
API Reference

The Bill Navigator end user status API allows you to update the status of an end user's account.

You can update Bill Navigator users to a Deactivated and Terminated status. These statuses affect how user data is handled and the experience a user will have upon returning to the platform.

Deactivated Status

  • Data Retention: All user data is retained.
  • User Experience: If a deactivated user logs back into their account, they will encounter a prompt asking if they want to reactivate their account. Once reactivated, all pre-existing data will be available to them as it was before deactivation.

Terminated Status

  • Data Deletion: All user data is permanently deleted.
  • User Experience: If a terminated user attempts to log back in, they will not see any pre-existing data. The account will appear as though it is entirely new, with no historical information or configuration carried over.
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!