Required Parameters
These parameters are mandatory for successful SDK initialization. Applies to: All integrations.
| Parameter | Type | Description |
| userId | string | Unique identifier for the user. Must be at least 2 characters — a shorter/missing value posts an error_occurred message instead of verifying. Used for tracking progress, analytics, and personalization |
| company | string | Company name associated with the API key. Determines the default theme name and which content the user can access. Compared case-insensitively (lowercased internally) |
| key | string | API key for authentication. Sent as the x-api-key header on the verify call and used as the company content filter |
Session-based authentication: integrations that use KinesteX session tokens may pass session (a session ID string) instead of key. Verification succeeds when either key or session is present. On the session path the user identity and subscription status are resolved server-side, and the verify response's is_subscribed overrides any host-passed isSubscribed flag.
SDK Support: All platforms support these as direct parameters.
Required Parameters Setup
Swift example:
1// Direct SDK support
2let kinestex = KinesteXAIKit(
3 apiKey: "YOUR_API_KEY",
4 companyName: "YOUR_COMPANY",
5 userId: "unique-user-id"
6)