Skip to main content

API Key Management

The API Key Management section allows you to create and manage keys for programmatic access to the Visual Passcodes administrative APIs. This is useful for automating user management, client registration, or other administrative tasks.

Creating a New API Key​

To create a new key, navigate to the API Keys section from the main menu or your Profile page and click the + Create New API Key button.

Create New API Key Form

  • Key Name: Provide a descriptive name for your key to easily identify its purpose.

  • Scopes: Scopes define the permissions that the API key will have. You must select one or more scopes to grant specific access rights. The available scopes determine which API endpoints the key can access.

    Examples of scopes shown include:

    • USER: General access to user-related endpoints.
    • USER:READ: Read-only access to user information.
    • CLIENT: General access to client-related endpoints.
    • CLIENT:READ: Read-only access to client configurations.
    • API_KEY:READ: Access to read API key information.

After creation, you will be shown the API key. Be sure to copy and store it in a secure location, as it will not be shown again.