User Creation

In Kinetix's API, a "user" represents one of your players.

To create a user, you need to make the following call:

Create user

post

Create a user from virtual world's user id

Authorizations

Body

idstringOptionalExample: myUserId123

Responses

200Success

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post

HTTPcURLJavaScriptPython

POST /v1/virtual-world/users HTTP/1.1
Host: sdk-api.kinetix.tech
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "id": "myUserId123"
}

{
  "message": "",
  "data": {
    "id": 1,
    "virtualWorldId": 1,
    "createdAt": "2025-05-16T16:31:55.051Z",
    "virtual_world_id": "text"
  }
}

Important Considerations:

• Unique Anonymized Identifier: Use a unique anonymized identifier for each user. Kinetix does not store any personal information about the player except for the animation files that are generated by them through Kinetix. It is your responsibility to prevent duplication or collision between your users.

  • In our FiveM implementation, we use the FiveM license field as the user ID. As a consequence, if a FiveM user has multiple characters created in your server, all these characters will share the same user-generated emotes.

• Emote Association: Each emote, once created, will be associated with the user ID to build their emote bag.

  • In our FiveM implementation, users are created on the fly before they request a new emote.

  • Alternatively, you can create a batch script to bulk import your user base into your Kinetix application.

By default, the user id is retrieved with this method.

function GetUserId(source)
    local playerIdentifiers = GetPlayerIdentifiers(source)
    return GetLicense(playerIdentifiers)
end

In the case of multi character, you might want to adapt this function with an character specific id.