identify()

A function that creates an account with Superwall by linking a userId to the automatically generated alias.

Call this as soon as you have a user ID, typically after login or when the user's identity becomes available.

Purpose

Links a user ID to Superwall's automatically generated alias, creating an account for analytics and personalization.

Signature

public func identify(
  userId: String,
  options: IdentityOptions? = nil
)

Parameters

Name	Type	Description
`userId`	`String`	Your user's unique identifier, as defined by your backend system.
`options`	`IdentityOptions?`	Optional configuration for identity behavior. Set `restorePaywallAssignments` to `true` to wait for paywall assignments from the server. Use only in advanced cases where users frequently switch accounts. Defaults to `nil`.

Returns / State

This function returns Void. After calling, isLoggedIn will return true and userId will return the provided user ID.

Usage

Basic identification:

Superwall.shared.identify(userId: "user_12345")

With options for account switching scenarios:

let options = IdentityOptions()
options.restorePaywallAssignments = true

Superwall.shared.identify(
  userId: "returning_user_67890",
  options: options
)

Call as soon as you have a user ID:

func userDidLogin(user: User) {
  Superwall.shared.identify(userId: user.id)
  
  // Set additional user attributes
  Superwall.shared.setUserAttributes([
    "email": user.email,
    "plan": user.subscriptionPlan,
    "signUpDate": user.createdAt
  ])
}