PingOne Platform APIs

Verify Voice Phrases (deprecated)

The service stores reference data about the user that is later used in verify transactions. For voice verification, an enrollment transaction is necessary to store voice reference data. The voice reference data is then used during voice verification. Voice verification cannot be performed for a user if enrollment has not been performed.

Voice verification is deprecated and will be removed on November 25, 2026.

Voice verification does not evaluate the spoken words and therefore is language-independent and can be text-independent when used with longer speech streams. For interactive voice enrollment or verification, between the service and a user’s mobile device, the user reads aloud a voice phrase that is submitted to the service. Verify voice phrases are the phrases that the user reads aloud. For non-interactive voice enrollment and verification, longer voice recordings are submitted without specific phrases spoken.

Some phrases are pre-defined by the service. However, customers can define their own, custom phrases.

Voice phrases are a container with a name. The actual phrases to speak are in contents, where the content has a locale and the phrase to speak written in the language required by the locale. Pre-defined phrases have contents in the locales supported by PingOne in their products. Because they are only read by a native speaker, custom voice phrases can be any locale and written in any language or character set.

To define a custom voice phrase:

  1. Create a custom voice phrase (deprecated) container to hold the localized contents.

  2. Create a custom voice phrase content (deprecated) with the locale and content.

Verify voice phrase data model

Property Type Required? Mutable? Description

id

String

N/A

Read-only

Voice phrase identifier. For customer-defined phrases, a UUID. For pre-defined phrases, a string derived from displayName.

environment.id

String

Required

Immutable

Ping environment identifier (UUID) for user

displayName

String

Required

Mutable

Suggested text to show for this voice phrase on a user interface. Must be unique within the environment identified by environment.id.

createdAt

DateTime

N/A

Read-only

This field records the date and time the verify phrase was created

updatedAt

DateTime

N/A

Read-only

This field records the date and time the verify phrase was updated; can be null

Verify voice phrase contents data model

Property Type Required? Mutable? Description

id

String

N/A

Read-only

Voice phrase identifier. For customer-defined phrases, a UUID. For pre-defined phrases, a string derived from displayName.

environment.id

String

Required

Immutable

Ping environment identifier (UUID) for user

voicePhrase.id

String

Required

Immutable

Identifier (UUID) for the voice phrase for which this is contents

locale

String

Required

Mutable

Locale for content

content

String

Required

Mutable

Phrase users must speak and write in the language specified by locale

createdAt

DateTime

N/A

Read-only

This field records the date and time the verify policy was created

updatedAt

DateTime

N/A

Read-only

This field records the date and time the verify policy was updated; can be null