Event data object

IDENTITY event

The event data object for an IDENTITY event must include all the required attributes for event data 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
`expiryDate`	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 object can optionally include personally identifiable information (PII):

Attribute	Type	Description	Example
`email`	string (lowercase recommended)	The email address of the guest.	`"[email protected]"`
`title`	string (title case)	The title of the guest.	`"Miss"` `"Mr"` `"Mrs"` `"Ms"`
`firstName`	string (title case recommended)	The first name of the guest.	`"Jane"`
`lastName`	string (title case recommended)	The last name of the guest.	`"Doe"`
`gender`	string	The gender of the guest.	`"female"`
`dob`	string (ISO 8601)	The date of birth of the guest.	`"1983-04-15T00:00"`
`mobile`	string	The mobile number of the guest.	`"+3531234567"`
`phone`	string	The phone number of the guest.	`"+3531234567"`
`street`	array of strings (title case recommended)	The street address of the guest.	`["Tara Street"]`
`city`	string (title case recommended)	The city address of the guest.	`"Dublin"`
`state`	string (title case recommended)	The state address of the guest.	`"Oregon"`
`country`	string (uppercase ISO 3166-1 alpha-2)	The country address of the guest.	`"IE"`
`postalCode`	string	The postal code of the guest.	`"D2"`

After you create this event data object, you can optionally extend this event using the extension data object. Then, you can send the event using the [Engage.identity()](engage-identity.md "Engage.identity(eventData[, extensionData])") function.

Here's an example of the event data object for an IDENTITY event. This event data object contains the identifiers array of objects and the following, optional PII attributes: email, firstName, lastName.

const eventData = {
    channel: "WEB",
    currency: "EUR",
    pointOfSale: "myretailsite/ireland",
    language: "EN",
    page: "home",
    email: "[email protected]",
    firstName: "Jane",
    lastName: "Doe",
    identifiers: [
        {
            id: "123456",
            provider: "BXLP"
        }
    ]
}

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