Skip to main content
POST
/
user_identities
/
create
await seam.userIdentities.create({
  user_identity_key: "61c6c8ec-21ac-4d1d-be02-688889c66d8c",
  email_address: "jane@example.com",
  phone_number: "+15551234567",
  full_name: "Jane Doe",
  acs_system_ids: ["c359cba2-8ef2-47fc-bee0-1c7c2a886339"],
});

/*
{
  "created_at": "2025-06-16T16:54:17.946546Z",
  "display_name": "Jane Doe",
  "email_address": "jane@example.com",
  "errors": [],
  "full_name": "Jane Doe",
  "phone_number": "+15551234567",
  "user_identity_id": "43947360-cdc8-4db6-8b22-e079416d1d8b",
  "user_identity_key": "jane_doe",
  "warnings": [],
  "workspace_id": "b7e0a4e0-1044-4319-9a0b-42b642b68c7f"
}
*/
{
  "ok": true,
  "user_identity": {
    "acs_user_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "email_address": "jsmith@example.com",
    "errors": [
      {
        "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>"
      }
    ],
    "full_name": "<string>",
    "phone_number": "<string>",
    "user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_identity_key": "<string>",
    "warnings": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
acs_system_ids
string<uuid>[]

List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.

​
email_address
string<email> | null

Unique email address for the new user identity.

​
full_name
string | null

Full name of the user associated with the new user identity.

Minimum string length: 1
​
phone_number
string | null

Unique phone number for the new user identity in E.164 format (for example, +15555550100).

​
user_identity_key
string | null

Unique key for the new user identity.

Minimum string length: 1

Response

OK

​
ok
boolean
required
​
user_identity
object
required

Represents a user identity associated with an application user account.