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: uuid
Example: 00000000-0000-0000-0000-000000000000

---

handlestringrequired
The handle of the identity verification. Is unique.
Example: verification-a

---

aliasstring | nullrequired
The alias of the identity verification.
Example: Verification A

---

statestringrequired
The state of the identity verification.
Format: VerificationState (string)
Possible values: [performing, performed, performedWithoutScore, error]
Example: performed

---

modelstringrequired
The model of the identity verification.
Example: default/v1.0

---

audio

object | null

required

The audio of the identity verification.

---

handlestringrequired

The handle of the audio. Is unique.

Example: audio-a

---

aliasstring | nullrequired

The alias of the audio.

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.

Example: voiceprint-a

---

aliasstring | nullrequired

The alias of the voiceprint.

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.

Example: identity-a

---

aliasstring | nullrequired

The alias of the identity.

Example: Identity A

---

scorenumber | nullrequired
The score of the identity verification.
Format: float
Possible values: <= 1
Example: 0.85

---

createdAtstringrequired
The date and time when the identity verification was created.
Format: date-time
Example: 2023-01-01T00:00:00.000000Z

---

performedAtstringrequired
The date and time when the identity verification was performed.
Format: date-time
Example: 2023-01-01T00:00:00.000000Z

IdentityVerification

{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "verification-a",
  "alias": "Verification A",
  "state": "performed",
  "model": "default/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"
    }
  },
  "score": 0.85,
  "createdAt": "2023-01-01T00:00:00.000000Z",
  "performedAt": "2023-01-01T00:00:00.000000Z"
}