Identity Verification

Identity verifications analyze the similarity between the biometric characteristics of an audio and those encapsulated by a voiceprint to validate that they belong to the same identity.

They can be used for biometric-based access control or to validate that the voice of a media fragment belongs to a certain speaker.

Combining identity verifications with authenticity and message verifications can greatly improve robustness against spoofing attempts.

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

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

Model: The analysis and comparison of the biometric characteristics of the voice is powered by a specific version of an identity verification model.

Score: Confidence in a positive result is represented by the score.

Fields

idstringrequired

The UUID of the identity verification. Is unique.

Format: string<uuid>

Example: 00000000-0000-0000-0000-000000000000

handlestringrequired

The handle of the identity verification. Is unique.

Format: string<handle>

Example: verification-a

aliasstring | nullrequired

The alias of the identity verification.

Format: string,null<alias>

Example: Verification A

statestringrequired

The state of the identity verification.

Format: VerificationState (string)

Possible values: [performing, performed, performedWithoutScore, error]

Example: performed

modestring

The mode of the identity verification.

Format: VerificationMode (string)

Possible values: [restApi, websocket]

Example: restApi

modelstringrequired

The model of the identity verification. See identity verification models.

Example: phone/v1.0

audio

object | null

required

The audio of the identity verification.

handlestringrequired

The handle of the audio. Is unique.

Format: string<handle>

Example: audio-a

aliasstring | nullrequired

The alias of the audio.

Format: string,null<alias>

Example: Audio A

statestringrequired

The state of the audio.

Format: AudioState (string)

Possible values: [avaitingFile, available, notAvailable]

Example: available

voiceprint

object | null

required

The voiceprint of the identity verification.

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

statestring

The state of the voiceprint

Format: VoiceprintState (string)

Possible values: [notComputable, computable, computed]

Example: notComputable

identity

object

required

The identity of 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

durationstring

The duration of the audio.

Format: string<duration>

Example: PT3.500S

voiceDurationstring

The voice duration of the audio.

Format: string<duration>

Example: PT3.500S

scorenumber | nulldeprecated

The score of the identity verification. This field is deprecated, use

scores.identity

instead. Only returned for the default and telephone models.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

scores

object

required

The scores of the identity verification.

identitynumber | nullrequired

The identity score of the identity verification.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

synthesisnumber | nullrequired

The synthesis score of the identity verification.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

synthesis_sources

object

required

The synthesis source scores of the identity verification.

awsnumber | null

The score of the source tracing of the AWS provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

azurenumber | null

The score of the source tracing of the Azure provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

deepgramnumber | null

The score of the source tracing of the Deepgram provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

elevenlabsnumber | null

The score of the source tracing of the ElevenLabs provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

googlenumber | null

The score of the source tracing of the Google provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

ibmnumber | null

The score of the source tracing of the IBM provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

lmntnumber | null

The score of the source tracing of the LMNT provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

murfnumber | null

The score of the source tracing of the Murf provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

openainumber | null

The score of the source tracing of the OpenAI provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

playhtnumber | null

The score of the source tracing of the PlayHT provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

speechifynumber | null

The score of the source tracing of the Speechify provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

othernumber | null

The score of the source tracing of the other provider.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

replaynumber | nullrequired

The replay score of the identity verification.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

createdAtstringrequired

The date and time when the identity verification was created.

Format: string<date-time>

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

performedAtstringrequired

The date and time when the identity verification was performed.

Format: string<date-time>

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

IdentityVerification
{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "verification-a",
  "alias": "Verification A",
  "state": "performed",
  "mode": "restApi",
  "model": "phone/v1.0",
  "audio": {
    "handle": "audio-a",
    "alias": "Audio A",
    "state": "available"
  },
  "voiceprint": {
    "handle": "voiceprint-a",
    "alias": "Voiceprint A",
    "state": "notComputable",
    "identity": {
      "handle": "identity-a",
      "alias": "Identity A"
    }
  },
  "duration": "PT3.500S",
  "voiceDuration": "PT3.500S",
  "scores": {
    "identity": 0.85,
    "synthesis": 0.85,
    "synthesis_sources": {
      "aws": 0.85,
      "azure": 0.85,
      "deepgram": 0.85,
      "elevenlabs": 0.85,
      "google": 0.85,
      "ibm": 0.85,
      "lmnt": 0.85,
      "murf": 0.85,
      "openai": 0.85,
      "playht": 0.85,
      "speechify": 0.85,
      "other": 0.85
    },
    "replay": 0.85
  },
  "createdAt": "2023-01-01T00:00:00.000000Z",
  "performedAt": "2023-01-01T00:00:00.000000Z"
}

Fields​

Fields