PingOne Platform APIs

Verify Reference Data (deprecated)

Verify reference data is any data submitted by the user, or by a PingOne customer on behalf of the user, to the verification service as reference material for later comparison during verification. Reference data are voice samples. Verify reference data is retained for an indefinite period of time, although it can be deleted.

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

Verify reference data data model

The data property can contain rather large base64-encoded data. To reduce message size, it is not returned by Read All Reference Data (deprecated). Use that call to find the id of a specific reference data and then use Read One Reference Data (deprecated) to retrieve it.
Property Type Required? Mutable? Description

id

String

N/A

Read-only

Reference data identifier (UUID or textual descriptor)

environment.id

String

Required

Immutable

Ping environment identifier (UUID) of the user

user.id

String

Required

Immutable

Identifier (UUID) for the user

type

String

Required

Immutable

The type of reference data represented; can be VOICE

data

Object

Required

Mutable

User’s reference data: data object

createdAt

DateTime

N/A

Read-only

Date and time the reference data was created

updatedAt

DateTime

N/A

Read-only

Date and time the reference data was updated; can be null

data object

The data object can contain rather large base64-encoded data and therefore is returned only with Read One Reference Data (deprecated). To find the id for specific reference data, use Read All Reference Data (deprecated) and find the 'id of the reference data to retrieve.
Property Type Required? Mutable? Description

voiceRecordings

Object[]

Optional

Mutable

Array of voice recording objects

voiceRecordings.id

String

N/A

Read-only

Voice recording identifier (UUID)

voiceRecordings.recording

String

Required

Mutable

Base64-encoded voice recording submitted

voiceRecordings.channel

String

Required

Mutable

Source of the voice recording submitted; can be MIC (from user’s mobile device microphone) or TEL (from a recorded telephone call with the user)

voiceRecordings.createdAt

DateTime

N/A

Read-only

Date and time the voice recording was created

voiceRecordings.updatedAt

DateTime

N/A

Read-only

Date and time the voice recording was updated; can be null

voiceTemplates

Object[]

Required

Mutable

Array of voice template (created from the voice recordings) objects

voiceTemplates.id

String

N/A

Read-only

Voice template identifier (UUID)

voiceTemplates.template

String

Required

Mutable

Base64-encoded voice template extracted from a submitted recording

voiceTemplates.mergedTemplate

Boolean

Required

Mutable

Whether new templates should be merged into existing templates to adapt to the user’s voice changes over time

voiceTemplates.channel

String

Required

Mutable

Source of the voice template submitted; can be MIC (from user’s mobile device microphone) or TEL (from a recorded telephone call with the user)

voiceTemplates.
voiceSdkVersion

Object

N/A

Read-only

Information regarding the SDK used to create the template

voiceTemplates.
voiceSdkVersion.version

String

N/A

Read-only

Version of the SDK

voiceTemplates.
voiceSdkVersion.initializationDataId

String

N/A

Read-only

Identifier of the initialization data

voiceTemplates.
voiceSdkVersion.algorithm

String

N/A

Read-only

Algorithm used

voiceTemplates.sourceTemplateIds

String[]

Optional

Mutable

Array of voice template identifiers (UUIDs) of the voice templates merged into this template when voiceTemplates.mergedTemplate is true

voiceTemplates.createdAt

DateTime

N/A

Read-only

Date and time the voice template was created

voiceTemplates.updatedAt

DateTime

N/A

Read-only

Date and time the voice template was updated; can be null

voicePhraseContent

Object

N/A

Read-only

Voice phrase content used to create the reference data; refer to xref:[Verify voice phrase contents data model]

createdAt

DateTime

N/A

Read-only

Date and time the voice recording was created

updatedAt

DateTime

N/A

Read-only

Date and time the voice recording was updated; can be null