Skip to main content

Identities

Identities are the optional representation of the people speaking on the audios uploaded to the platform. They can also be used to create voiceprints and to perform identity verifications.

Access: To manage an identity, you must have access to its space.

Isolation: An identity can only interact with resources inside its space.

Identities must not be confused with users, which represent human administrators on the platform.

 

Fields


    idstringrequired

    The UUID of the identity. Is unique.

    Format: uuid
    Example: 00000000-0000-0000-0000-000000000000

    handlestringrequired

    The handle of the identity. Is unique.

    Example: identity-a

    aliasstring | nullrequired

    The alias of the identity.

    Example: Identity A

    audiosintegerrequired

    The number of audios of the identity.

    Format: int32
    Example: 10

    voiceprintsintegerrequired

    The number of voiceprints of the identity.

    Format: int32
    Example: 10

    verificationsintegerrequired

    The number of verifications of the identity.

    Format: int32
    Example: 10

    createdAtstringrequired

    The date and time when the identity was created.

    Format: date-time
    Example: 2023-01-01T00:00:00.000000Z
Identity
{
"id": "00000000-0000-0000-0000-000000000000",
"handle": "identity-a",
"alias": "Identity A",
"audios": 10,
"voiceprints": 10,
"verifications": 10,
"createdAt": "2023-01-01T00:00:00.000000Z"
}