---
title: "IdentityData"
slug: "cloud-sdk-events-identitydata-1748078"
abstract: "The IdentityData interface represents data for IDENTITY events."
---
# IdentityData

|     |     |
| --- | --- |
| Type | Interface |
| Extends | [`EventAttributesInput`](https://doc.sitecore.com/sdk/en/developers/006/cloud-sdk/cloud-sdk-reference/cloud-sdk-events/cloud-sdk-events-browser/interfaces/cloud-sdk-events-eventattributesinput.html "EventAttributesInput") |
| Import path | `@sitecore-cloudsdk/events/server` |

Data for [`IDENTITY`](https://doc.sitecore.com/sdk/en/developers/006/cloud-sdk/cloud-sdk-concepts/concepts-tracking/events/identity-events.html "IDENTITY events") events.

## Signature

```typescript
export interface IdentityData extends EventAttributesInput {
  city?: string;
  country?: string;
  dob?: string;
  email?: string;
  firstName?: string;
  gender?: string;
  identifiers: Identifier[];
  lastName?: string;
  mobile?: string;
  phone?: string;
  postalCode?: string;
  state?: string;
  street?: string[];
  title?: string;
  extensionData?: ExtensionData;
}
```

## Properties

| Name | Type | Description | Value |
| --- | --- | --- | --- |
| city | string | Optional.The site visitor's city address.Format: title case recommended. | "Dublin" |
| country | string | Optional.The site visitor's country address.Format: uppercase ISO 3166-1 alpha-2. | "IE" |
| dob | string | Optional.The site visitor's date of birth.Format: ISO 8601. | "1984-04-15" |
| email | string | Optional.The site visitor's email address.Format: lowercase recommended. | "jane.doe@myretailsite.com" |
| firstName | string | Optional.The site visitor's first name.Format: title case recommended. | "Jane" |
| gender | string | Optional.The site visitor's gender. | "female""male""unknown" |
| identifiers | Identifier[] | Required.The identifiers used for identifying site visitors. | identifiers: [{ id: "123456", provider: "BXLP" }] |
| lastName | string | Optional.The site visitor's last name.Format: title case recommended. | "Doe" |
| mobile | string | Optional.The site visitor's mobile number. | "+3531234567" |
| phone | string | Optional.The site visitor's phone number. | "+3531234567" |
| postalCode | string | Optional.The site visitor's postal code. | "D2" |
| state | string | Optional.The site visitor's state address.Format: title case recommended. | "Oregon" |
| street | string[] | Optional.The site visitor's street address.Format: title case recommended. | ["Tara Street"] |
| title | string | Optional.The site visitor's title.Format: title case. | "Miss""Mr""Mrs""Ms" |
| extensionData | ExtensionData | Optional.Any custom data to collect about an event in addition to the other attributes provided for the event data. | { customKey: "customValue" } |

### `Identifier` properties

| Name | Type | Description | Value |
| --- | --- | --- | --- |
| `id` | `string` | Required.<br><br>The unique guest (site visitor) identifier provided by your organization's identity system, such as a Customer Relationship Management (CRM) system. | `"123456"` |
| `provider` | `string` | Required.<br><br>The name of your organization's identity system, external to SitecoreAI, that provided the unique guest (site visitor) identifier. | `"BXLP"` |
| `expiryDate` | `string` | Optional.<br><br>The date the unique guest (site visitor) identifier expires. This is determined by your organization's identity system.<br><br>Format: [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). | `"2026-04-15T08:`39:44`.868Z"` |

## Examples

Here's a basic event data object for an `IDENTITY` event:

```typescript
const eventData: any = {
  identifiers: [
    {
      id: "123456",
      provider: "BXLP"
    }
  ]
};
```

Here's an example event data object for an `IDENTITY` event with required and optional event data, and extension data:

```typescript
const eventData: any = {
  language: "EN",
  page: "home",
  channel: "WEB",
  currency: "EUR",
  email: "jane.doe@myretailsite.com",
  title: "Miss",
  firstName: "Jane",
  lastName: "Doe",
  gender: "female",
  dob: "1984-04-15",
  mobile: "+3531234567",
  phone: "+3531234567",
  street: ["Tara Street"],
  city: "Dublin",
  country: "IE",
  identifiers: [
    {
      id: "123456",
      provider: "BXLP",
    },
  ],
  extensionData: { customKey: "customValue" }
};
```