Skip to main content

authentication

The Instinct API uses a simple authentication mechanism to secure access to the headset's functionality.

authentication method​

important

For Nexstem headsets, authentication occurs exclusively through the Nexstem companion app. This is the only authentication method available. API Keys, Session-Based Authentication, and OAuth 2.0 are not applicable.

authentication flow​

  1. Initial Setup:

    • Download and install the Nexstem companion app on your mobile device
    • Create a Nexstem account (if you don't already have one)
    • Log in to the companion app using your account credentials

  2. Headset Authentication:

    • Turn on your Instinct headset
    • Open the companion app
    • Follow the instructions to pair and authenticate with your headset
    • The companion app will establish an authenticated connection with the headset

  3. API Access:

    • Once authenticated through the companion app, the authentication token is stored locally in the headset's master interface component
    • All subsequent API requests to the headset will use this stored token automatically
    • No API key or authentication header is required in your requests

authentication status​

To verify the authentication status of your headset:

curl -X GET http://localhost:42069/auth/status

Example response:

{
  "success": true,
  "authenticated": true,
  "user": {
    "id": "user123",
    "email": "[email protected]"
  }
}

authentication errors​

If you encounter authentication errors when using the API, it typically means:

  1. The headset has not been properly authenticated through the companion app
  2. The authentication token has expired (requires re-authentication via the app)
  3. The API you are trying to access requires a different authorization level

security considerations​

For security purposes:

  1. The headset's API server only accepts connections from the local network
  2. The authentication token is never exposed to API clients
  3. Authentication through the companion app uses secure, encrypted communication

next steps​