Verifications

Verifications are performed on audios to analyze and measure certain characteristics, which vary depending on the type of verification.

The generic verifications endpoint provides a unified view of all the different types, displaying only their common fields.

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

Isolation: Verifications can only interact with resources inside its space.

Model: The analysis of the relevant characteristics is powered by a specific version of a verification model.

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

Types

Identity

Authenticity

Message

 

Fields

---

idstringrequired
The UUID of the verification. Is unique.
Format: uuid
Example: 00000000-0000-0000-0000-000000000000

---

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

---

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

---

typestringrequired
The type of the verification.
Format: VerificationType (string)
Possible values: [identity, authenticity, message]
Example: authenticity

---

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

---

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

---

audio

object | null

required

The audio of the 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

---

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

---

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

---

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

Verification

{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "verification-a",
  "alias": "Verification A",
  "type": "authenticity",
  "state": "performed",
  "model": "default/v1",
  "audio": {
    "handle": "audio-a",
    "alias": "Audio A",
    "state": "available"
  },
  "score": 0.85,
  "createdAt": "2023-01-01T00:00:00.000000Z",
  "performedAt": "2023-01-01T00:00:00.000000Z"
}