IDENTITY events

Version:

The IDENTITY event is used to resolve the identity of an anonymous site visitor (guest guest) of your app. When Sitecore receives an IDENTITY event, typically captured in registration, login, and signup forms, Sitecore CDP runs a linking algorithm to try to match guest data from separate guest profiles, based on your organization's identity rules. We recommend that you learn about identity resolution in Sitecore CDP before you start sending IDENTITY events.

You can send IDENTITY events by using the identity function and passing it the identity event data object.

The identity event data object

The identity event data object represents all the required and optional data about the event.

This is the object where you provide data about the event. All this data is sent to Sitecore, so make sure to provide the correct data depending on your organization's requirements. Construct the object in the following way:

Provide the identifiers array. In the array, include the name of your organization's identity system and the unique guest identifier provided by that system.
Optionally, you can:
- Provide data such as the channel and the language of the page where the event triggered, and personally identifiable information (PII) such as the site visitor's email address, first name, and last name.
- Include the extension data object.

Examples

Tip

During development, use your web browser's developer tools to check the payload containing all the event data that is sent to Sitecore.

Example 3. Sending an IDENTITY event

Here's an example identity event data object for an IDENTITY event. The object contains all the required event data, and some optional event data and extension data:

const eventData: any = {
  language: "EN",
  page: "home",
  channel: "WEB",
  currency: "EUR",
  email: "[email protected]",
  title: "Miss",
  firstName: "Jane",
  lastName: "Doe",
  gender: "female",
  mobile: "+3531234567",
  phone: "+3531234567",
  street: ["Tara Street"],
  city: "Dublin",
  country: "IE",
  identifiers: [
    {
      id: "123456",
      provider: "BXLP",
    },
  ],
  extensionData: { customKey: "customValue" }
};

You can send this event by passing the object to the identity function:

Browser module

// ...
identity(eventData);
// ...

Server module

// ...
await identity(request, eventData);
// ...

For this identity event data object, the following payload is sent to Sitecore:

{
  "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
  "channel": "WEB",
  "city": "Dublin",
  "client_key": "",
  "country": "IE",
  "currency": "EUR",
  "email": "[email protected]",
  "ext": {
    "customKey": "customValue"
  },
  "firstname": "Jane",
  "gender": "female",
  "identifiers": [
    {
      "id": "123456",
      "provider": "BXLP"
    }
  ],
  "language": "EN",
  "lastname": "Doe",
  "mobile": "+3531234567",
  "page": "home",
  "phone": "+3531234567",
  "pos": "",
  "requested_at": "2025-10-05T10:36:32.506Z",
  "street": [
    "Tara Street"
  ],
  "title": "Miss",
  "type": "IDENTITY"
}

If you have suggestions for improving this article, let us know!