ForgetMe essentials

The ForgetMe API requests the removal of customer data in event logs stored outside the Nuance event log repository.

The event log repository automatically deletes logs after 28 days, and audio files after 14 days, so there’s no need to request the removal of these logs. However, other Nuance entities such as Mix Discover and reporting copy logs to their own data stores, and may not automatically delete them. You can use the ForgetMe API to request the deletion of your data from these data stores.

XaaS requests

If logging is enabled for your Mix application, your requests to XaaS services (ASRaaS, NLUaaS, DLGaaS, TTSaaS, NRaaS) are logged in the Nuance event log repository. Requests with a user_id and/or session_id include a userid and/or sessionid field in the event logs.

The user_id field is logged as userid. It is hashed with SHA256, as described in User ID, because it contains personal information. For example, this user_id:

user_id = 'eric@aardvark.com'

is hashed and logged as userid in the event logs for the fictional app ID NMDPTRIAL_your_name_20200123T153120765439:

"userid":"f299b37de699b999c9e1ebb3c8dfddb38786521680da61c007181f577c3286d0",

For session_id, the value is logged as sessionid in plain text. For example, this sessionId returned by a DLGaaS request:

sessionId': '92705444-cd59-4a04-b79c-e67203f04f0d'

is logged in plain text as sessionid:

"sessionid": "92705444-cd59-4a04-b79c-e67203f04f0d",

Forget requests

You can use the ForgetMe service if you wish to delete the data in the event logs copied to other Nuance data stores. Your requests are logged in the event log repository, and Nuance administrators carry out the actual removal of the data.

Send a ForgetRequest with a forget_id containing either a user ID or session ID, and set the type (USER or SESSION) in the forget_type field.

For example, to remove logs associated with a user ID:

ForgetRequest (
    forget_id = 'eric@aardvark.com`,
    forget_type = USER
)

This request is logged in the event log repository, using the hashed form of the forget_id. This value is the same as the hash of the original user_id:

{
  "value":{
    "service":"Fabric",
    "type":"Forgetme",
    "data":{
      "forgetmeid":"f299b37de699b999c9e1ebb3c8dfddb38786521680da61c007181f577c3286d0",
      "forgetmeType":"USER"
    }
  }
}

To remove logs for a session ID:

ForgetRequest (
    forget_id = '92705444-cd59-4a04-b79c-e67203f04f0d`, 
    forget_type = SESSION
)

This request is logged using the plaintext form of the forget_id:

{
  "value":{
    "service":"Fabric",
    "type":"Forgetme",
    "data":{
      "forgetmeid":"92705444-cd59-4a04-b79c-e67203f04f0d",
      "forgetmeType":"SESSION"
    }
  }
}

Data removal

Nuance administrators regularly poll the event logs, looking for Fabric ForgetMe requests. They search the XaaS logs, matching the forgetmeid value with userid or sessionid, and then delete the associated records.