Skip to main content
Using Alias ID

Alias ID can be used to simplify integration by adding a known ID from the integrating system in Parakey, for example, a room ID.

Emil Janitzek avatar
Written by Emil Janitzek
Updated over a week ago

Alias ID can be used to create a stateless integration with Parakey. Using an Alias ID there is no need to store any extra information about Access ID in the integrating system. Instead, Parakey will handle the mapping between your ID and the Parakey Access ID.

Please note that Alias ID is optional and you should only use an Alias ID or the Access ID.

Add or change Alias ID on Keys (Access)

To use Alias ID in your API calls, you need to enter the Alias ID in Parakey Web Portal. This should represent a unique identifier in your system, for example, a room ID.

  1. Go to Keys and press the name of the key you want to update.

    ❗️The key needs to be allowed to be used with API. If it is not already, follow step 1-4 under Allow API integration for a key in this article.

  2. Under Settings, next to API, press Edit.


  3. Enter an Alias ID and press Save.

    💡 We always recommend using a prefix for your Alias ID, since the ID has to be unique within the Parakey system. For example you can use your company name as prefix.

To use the Alias ID, simply use this instead of the Access ID.

"insert": [{
"access": { "aliasId": "Parakey-123ABC" },
"user": { "email": "[email protected]" }

Did this answer your question?