Event object

IDENTITY event

The event object for an IDENTITY event must include all the required attributes for event objects plus the following attributes:

Attribute: Type
identifiers: array of objects

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 Personalize, 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.	`"2026-04-15T08:`39 `.868Z"`	Optional

The event object for an IDENTITY event can optionally include personally identifiable information (PII):

Attribute	Type	Description	Example	Required/optional
`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-15T08:`39 `.868Z"`	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
`postal_code`	string	The postal code of the guest.	`"D2"`	Optional

Example

This example describes an event object for an IDENTITY event in an integration that uses the Boxever JavaScript Library. The browser_id is set to the value that the [Boxever.getID()](bx-getid.md "Boxever.getID()") function returns. This event object contains the identifiers array of objects and the following, optional PII attributes: email, firstname, lastname.

const identityEvent = {
    browser_id: Boxever.getID(),
    channel: "WEB",
    type: "IDENTITY",
    language: "EN",
    currency: "EUR",
    page: "home",
    pos: "myretailsite/ireland",
    identifiers: [
        {
            id: "123456",
            provider: "BXLP"
        }
    ],
    email: "[email protected]",
    firstname: "Jane",
    lastname: "Doe"
};

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