User Management

Manage the session and avatar state of your users

There are two types of end-users coming to your app or game. Users with an existing Ready Player Me account and users without. For both of them, you want to create a seamless user experience.

There are two user types:

• Ready Player Me accounts

• Guest accounts

Ready Player Me accounts

Ready Player Me accounts are accounts of users who created an account at https://readyplayer.me or a subdomain (e.g. https://yoursubdomain.readyplayer.me). Those users want to log in with their credentials and reuse their existing avatars and unlocked assets in your game or app.

Most of your users won't have an existing Ready Player Me account. Still, you want to let them store their avatars and unlocked assets. That's where you can use guest accounts.

Guest Accounts

For all users, who don't have a Ready Player Me account, you can manage the user's account by creating a Guest account. This lets you authenticate all your requests with your API key. It also enables you to authenticate your users on the web avatar creator (WebView/iFrame), so that they can access their avatars and unlocked assets.

Learn how to create Guest Accounts

Account Linking

Users with an existing Ready Player Me account want to bring their avatars to your game. To ensure a great UX, you should implement Account Linking so those users only need login once and authorize your app or game to link their account. Account linking works the same for all three types of users.

Learn more about Account Linking

If you don't implement account linking and guest accounts, we try to restore the user's session from local storage in the browser. But this won't work in all cases. E.g., when a user switches to a different device, removes browser data, or their browser blocks session management in the local storage. For guest users, this means they lose their avatars. Users with a Ready Player Me account must log in whenever they come to your app or game.