Message Verification

Message verifications analyze the content of an audio to validate that the message found matches the one expected.

They can be used for knowledge-based or possession-based access control and to ensure that the audio is not pre-recorded.

Message verifications can make recording-based spoofing attempts unfeasible in identity and authenticity verifications and introduce complementary authentication factors.

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 messages found with the ones expected is powered by a specific version of a message verification model.

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

 

Fields

---

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

---

handlestringrequired
The handle of the message verification. Is unique.
Format: string<handle>
Example: verification-a

---

aliasstring | nullrequired
The alias of the message verification.
Format: string,null<alias>
Example: Verification A

---

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

---

modestring
The mode of the message verification.
Format: VerificationMode (string)
Possible values: [restApi, websocket]
Example: restApi

---

modelstringrequired
The model of the message verification. See message verification models.
Example: phone/v1

---

audio

object | null

required

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

---

messagestringrequired
The message of the message verification.
Possible values: non-empty and <= 200 characters
Example: The blue rhino traveled to distant lands

---

languagestringrequired
The language of the message verification.
Format: Language (string)
Example: en

---

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 message verification. This field is deprecated, use
scores.message
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 message verification.

---

messagenumber | nullrequired

The message score of the message verification.

Format: number,null<float>

Possible values: >= 0 and <= 1

Example: 0.85

---

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

---

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

MessageVerification

{
  "id": "00000000-0000-0000-0000-000000000000",
  "handle": "verification-a",
  "alias": "Verification A",
  "state": "performed",
  "mode": "restApi",
  "model": "phone/v1",
  "audio": {
    "handle": "audio-a",
    "alias": "Audio A",
    "state": "available"
  },
  "message": "The blue rhino traveled to distant lands",
  "language": "en",
  "duration": "PT3.500S",
  "voiceDuration": "PT3.500S",
  "scores": {
    "message": 0.85
  },
  "createdAt": "2023-01-01T00:00:00.000000Z",
  "performedAt": "2023-01-01T00:00:00.000000Z"
}