Voiceprints

Voiceprints belong to an identity and encapsulate the biometric characteristics of their voice, extracted from some of their audios.

Once computed, they can be used to perform identity verifications.

Access: To manage a voiceprint, you must have access to its space.

Isolation: A voiceprint can only interact with resources inside its space.

Composite handle: Voiceprints are tightly related to their identity and their handle is only unique in combination with them. Learn more.

Model: The extraction of the biometric characteristics of the voice is powered by a specific version of a voiceprint model.

Fields

idstringrequired

The UUID of the voiceprint. Is unique.

Format: string<uuid>

Example: 00000000-0000-0000-0000-000000000000

handlestringrequired

The handle of the voiceprint. Is unique.

Format: string<handle>

Example: voiceprint-a

aliasstring | nullrequired

The alias of the voiceprint.

Format: string,null<alias>

Example: Voiceprint A

statestringrequired

The state of the voiceprint

Format: VoiceprintState (string)

Possible values: [notComputable, computable, computed]

Example: notComputable

modelstringrequired

The model of the voiceprint. See voiceprint models.

Example: phone/v1

identity

object

required

The identity of the voiceprint.

handlestringrequired

The handle of the identity. Is unique.

Format: string<handle>

Example: identity-a

aliasstring | nullrequired

The alias of the identity.

Format: string,null<alias>

Example: Identity A

totalDurationstringrequired

The total duration of the audios added to the voiceprint.

Format: string<duration>

Example: PT7.500S

minAudiosintegerrequired

The minimum number of audios required to compute the voiceprint.

Format: integer<int32>

Example: 3

audiosintegerrequired

The number of audios added to the voiceprint.

Format: integer<int32>

Example: 2

verificationsintegerrequired

The number of verifications of the voiceprint.

Format: integer<int32>

Example: 10

createdAtstringrequired

The date and time when the voiceprint was created.

Format: string<date-time>

Example: 2023-01-01T00:00:00.000000Z

computedAtstringrequired

The date and time when the voiceprint was computed.

Format: string<date-time>

Example: 2023-01-01T00:00:00.000000Z

Voiceprint
{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "voiceprint-a",
  "alias": "Voiceprint A",
  "state": "notComputable",
  "model": "phone/v1",
  "identity": {
    "handle": "identity-a",
    "alias": "Identity A"
  },
  "totalDuration": "PT7.500S",
  "minAudios": 3,
  "audios": 2,
  "verifications": 10,
  "createdAt": "2023-01-01T00:00:00.000000Z",
  "computedAt": "2023-01-01T00:00:00.000000Z"
}

Fields​

Fields