IDENTITY event

An IDENTITY event contains data that enables Sitecore Personalize to perform identity resolution. When Sitecore Personalize 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 Personalize before you start sending IDENTITY events.

You can pass personally identifiable information (PII) to Sitecore Personalize 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 Personalize 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 Personalize 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:

The identifiers array of objects:

Example 38. IDENTITY event object with identifiers

{
    "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 39. IDENTITY event object with identifiers and personally identifiable information (PII)

{
    "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"
}

You can pass additional guest data in an event to Sitecore CDP. This new data is compared with existing guests to try and identify the guest. You must capture IDENTITY events wherever in the site 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:

The identifiers array of objects:

Example 40. IDENTITY event object with identifiers

{
    "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 41. IDENTITY event object with personally identifiable information (PII)

{
    "channel": "MOBILE_APP",
    "type": "IDENTITY",
    "language": "EN",
    "currency": "EUR",
    "page": "home",
    "pos": "spinair.com/france",
    "browser_id": "a38b230c-11eb-4cf9-8d5d-274e9f344925​",
    "email": "[email protected]",
    "title": "Ms",
    "firstname": "Jane",
    "lastname": "Doe",
    "gender": "female",
    "dob": "1980-01-23T00:00",
    "passport_no": "IR123456",
    "mobile": "+3531234567",
    "phone": "+3531234567",
    "street": ["Ashford House", "Tara Street", "Dublin 2"],
    "city": "Dublin",
    "country": "IE",
    "postCode": "D2",
    "identifiers": [{
        "provider": "BXLP",
        "id": "123456"
    }]
}