In this guide you will learn how to create an identity in a space. This is a prerequisite to compute voiceprints or perform identity verifications.

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

✦ Goal: create an identity and store its reference for future use.

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.

---> ownerspace

Procedure

1

Create the identity

Create the identity. See the API reference.

<--- ownerspace

You must choose the handle for the identity. Optionally, you may choose the alias.

Personally Identifiable Information (PII) should not be used as handles. Instead, use a transformation of your internal IDs to easily and securely map people across services.

---> ✦ identity

  • Request

  • Response

  • Method — POST
  • Path — /spaces/{owner}/{space}/identities
  • Body — application/json
{
  "handle": "{identity}"
}

Validation

1

Validate the identity details

To validate that the identity has been correctly created, retrieve and analyze its details. See the API reference.

<--- ownerspaceidentity

  • Request

  • Response

  • Method — GET
  • Path — /spaces/{owner}/{space}/identities/{identity}