identify

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

Use the identify command to set the unique identifier as the identity_id:

  nid('identify', identity_id);

Parameters

  • identify: 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

The identity_id must be the same identifier used to persist an applicant's identity in your system. You may refer to this as an Application ID, an Applicant ID, a User ID, a Customer ID, or something similar. No matter what you call it, you must set an identity_id that is unique to the applicant and also exists in your system.

If the unique identifier is unavailable in your database, persist the value used to your backend after creation and before calling the NeuroID Analytics API. You will use this value to call the NeuroID API for signals about the applicant.