Identity API

Deletes the contact's enrollment information

Deletes the voice biometrics enrollment information for a contact so the contact is no longer recognized by voice authentication, and resets the contact's consent status accordingly. Use this endpoint to opt-out an enrolled user, for example when the contact requests removal of their voice profile as part of a right-to-be-forgotten request or before re-enrolling from scratch.<br> The contact must already exist in voice biometrics, otherwise the request returns <b>404</b>; if the contact is already in a non-enrolled state, the call is treated as a no-op except for resetting consent. Downstream bookkeeping and provider-side voice profile deletion depend on whether the account has an Identity license, and subsequent authentication attempts for this contact will fail until a new enrollment is created.

delete/voicebiometrics/contacts/{contact_id}/enrollment

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/voicebiometrics/contacts/{contact_id}/enrollment
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: voicebiometrics-enroll:write

Path parameters

contact_idstring required

Response

No Content

Changes

No recorded changes to this operation across all 2 revisions of this API.