setRegisteredUserId

The identify command associates a unique identity with the signals collected for the session.

Use the setRegisteredUserId command to set a unique identifier to profile a registered users behavior:

  nid('setRegisteredUserId', registered_user_id);

Parameters

  • setRegisteredUserId: command
  • value (string): value for the identity id being passed for the session with the following requirements:
    • Must be a string value
    • Must consist of only alphanumeric characters, dashes, underscores, or period
    • A minimum length of 3-characters
    • A maximum length of 100-characters
    • Must not contain any PII

If the registeredUserId fails validation, it WILL NOT be set. A LOG event will be sent to the backend signaling that the registeredUserID failed validation, with the reason that it failed validation.

❗️

A registered User Id must correspond to a userId in your system, but should not be that exact Id. Do not set the registeredUserId as a true userId, as this can be personally identifiable information. The best practice is to use an existing alternate id that corresponds to a user, or a cryptographically secure hash of the userId.