IDENTITY event

An IDENTITY event contains data that enables Sitecore CDP to perform identity resolution. When Sitecore CDP receives an IDENTITY event, it 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 pass personally identifiable information (PII) to Sitecore CDP in an IDENTITY event using the following options:

To use PII data to perform identity resolution, you must send PII data using the identifiers object. For example, you can use a guest's email address to perform identity resolution. To do this, send the email attribute in the identifiers object. After Sitecore CDP receives the IDENTITY event, it adds the identifiers object to the guest profile, to use for identity resolution in the future.
To pass PII data to Sitecore CDP so that it is available as supplementary, additional information in the guest profile, send PII data outside the identifiers object.

You must capture IDENTITY events wherever in the site that the guest provides data that might help identify them. It is common for a single browser session to have multiple IDENTITY events.

To send an IDENTITY event, use the following attributes:

Attribute	Type	Description	Example	Required/optional
`channel`	string (uppercase)	The touchpoint where the user interacts with your brand.	`"MOBILE_APP"` `"MOBILE_WEB"` `"WEB"`	Required
`type`	string (uppercase)	The type of the event that takes place when the user interacts with your brand.	`"IDENTITY"`	Required
`language`	string (uppercase ISO 639-1)	The language the user is using your app in.	`"DE"` `"EN"` `"FR"`	Required
`currency`	string (uppercase ISO 4217)	The alphabetic currency code of the currency the user is using in your app.	`"EUR"` `"GBP"` `"USD"`	Required
`page`	string	The name of the webpage where the interaction with your brand takes place. This is a custom value of your choice.	`"home"` `"contact-us.html"`	Required
`pos`	string	The name of the point of sale where the interaction with your brand takes place.	`"myretailsite/ireland"` `"spinair.com/france"`	Required
`browser_id`	string	The browser ID.	`"a38b230c-11eb-4cf9-8d5d-274e9f344925"`	Required
`email`	string (lowercase recommended)	The email address of the guest.	`"[email protected]"`	Optional
`title`	string (title case)	The title of the guest.	`"Br", "Brigadier", "Capt", "Colonel", "Dame", "Dr", "Elder", "Fr", "General", "Hon", "Judge", "Lord", "Master", "Miss", "Mr", "Mrs", "Ms", "Mstr", "Prof", "Rabbi", "Rev", "Shaikha", "Sheikh", "Sir", "Sister", "Sr"`	Optional
`firstname`	string (title case recommended)	The first name of the guest.	`"Jane"`	Optional
`lastname`	string (title case recommended)	The last name of the guest.	`"Doe"`	Optional
`gender`	string	The gender of the guest.	`"female"`	Optional
`dob`	string (ISO 8601)	The date of birth of the guest.	`"1983-04-15T00:00"`	Optional
`mobile`	string	The mobile number of the guest.	`"+3531234567"`	Optional
`phone`	string	The phone number of the guest.	`"+3531234567"`	Optional
`street`	array of strings (title case recommended)	The street address of the guest.	`["Tara Street"]`	Optional
`city`	string (title case recommended)	The city address of the guest.	`"Dublin"`	Optional
`state`	string (title case recommended)	The state address of the guest.	`"Oregon"`	Optional
`country`	string (uppercase ISO 3166-1 alpha-2)	The country address of the guest.	`"IE"`	Optional
`postCode`	string	The postal code of the guest.	`"D2"`	Optional
`identifiers`	array of objects	The identifiers that are used to identify the users of your app.	N/A	Required

The identifiers array of objects:

Attribute	Type	Description	Example	Required/optional
`id`	string	The unique guest identifier provided by your organization's identity system, such as a Customer Relationship Management (CRM) system.	`"123456"`	Required
`provider`	string	The name of your organization's identity system, external to Sitecore CDP, that provided the unique guest identifier.	`"BXLP"`	Required
`expiry_date`	string (ISO 8601)	The date the unique guest identifier expires. This is determined by your organization's identity system.	`"2025-04-15T08:39:44.868Z"`	Optional

Example 35. IDENTITY event object with identifiers

RequestResponse

{
    "channel": "MOBILE_APP",
    "type": "IDENTITY",
    "language": "EN",
    "currency": "EUR",
    "page": "home",
    "pos": "myretailsite/ireland",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
    "identifiers": [{
        "provider": "BXLP",
        "id": "123456"
    }]
}

Example 36. IDENTITY event object with identifiers and personally identifiable information (PII)

RequestResponse

{
    "channel": "MOBILE_APP",
    "type": "IDENTITY",
    "language": "EN",
    "currency": "EUR",
    "page": "home",
    "pos": "myretailsite/ireland",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925",
    "identifiers": [
        {
            "id": "123456",
            "provider": "BXLP"
        }
    ],
    "email": "[email protected]",
    "firstname": "Jane",
    "lastname": "Doe"
}

Do you have some feedback for us?

If you have suggestions for improving this article,