In this guide you will learn how to perform a message verification on an audio.

If you are unfamiliar with these concepts, follow their links or read the API reference introduction.

✦ Goal: perform a message verification and obtain its score.

​
Prerequisites

1

Set up your HTTP client

Use the playground or automatically generate requests from the OpenAPI definition.

2

Authenticate using your credentials or API keys

Your API requests must be authenticated using your credentials or API keys.

3

Gain access to a space

You can only operate in spaces that belong to your user or to one of your organizations. Review these relationships if your access is denied.

---> owner space

4

Upload an audio

You must have uploaded an audio to the chosen space.

---> audio

5

Obtain the expected message and language

You must know the expected message and language of the audio before you can perform a message verification.

---> message language

Message verifications support a number of languages. See the API reference.

​
Procedure

1

Choose the message verification model

Check the available models and choose the one you will use to perform the verification. See the model index.

Each model has its own requirements. If you do not choose an appropriate one for your audio, you will receive an error when you attempt to perform the verification.

---> model

2

Perform the message verification

Perform the message verification on the uploaded audio with the chosen model, providing the expected message and language. See the API reference.

<--- owner space model audio message language

Optionally, you may choose the alias for the verification.

In verifications, the latest model version is automatically selected.

---> ✦ verification version ✦ score

In verifications, confidence in a positive result is represented by their scores. Learn more.

  • Method — POST
  • Path — /spaces/{owner}/{space}/verifications/message
  • Body — application/json
{
  "model": "{model}",
  "audio": "{audio}",
  "message": "{message}",
  "language": "{language}"
}

​
Validation

1

Validate the message verification details

To validate that the message verification has been correctly performed, retrieve and analyze its details. See the API reference.

<--- owner space verification

  • Method — GET
  • Path — /spaces/{owner}/{space}/verifications/message/{verification}
2

Validate the verification usage records

To validate that the message verification has been correctly performed, retrieve and analyze the verification usage records. See the API reference.

<--- owner

This step assumes that the owner is an organization. If you are the owner, you must use a slightly different endpoint. See the API reference.

  • Method — GET
  • Path — /orgs/{owner}/records/verification

Authenticity