Profile Schema

https://ns.adobe.com/xdm/context/profile

XDM Profiles are a singular representation of the attributes of identified and partially identified persons. Profiles that are highly identified maybe used for personal communications or highly targeted engagements and can contain detailed personal information such as names, gender, date of birth, locations, and contact information like phone numbers and email addresses. Profiles may range to the other end of the identification spectrum where only anonymous behavioral signals are being observed and the amount of identification is simple browser cookies. In this latter case, the sparse Profile data is useful to build more knowledge on the interests and preferences of the anonymous profile, and over time can become richer as the person interacting with brand becomes more engaged and ultimately signs-on to notifications, subscriptions, purchases and other connections with the brand that enrich and fill out the profile.

XDM Profile can contain personal information, identification information, contact details and communication preferences. Over time XDM Profile will expand to cater for other Profile data such as preference, propensities and other attributes.

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Experimental	No	Forbidden	Permitted	context/profile.schema.json

Schema Hierarchy

Profile https://ns.adobe.com/xdm/context/profile
- Extensibility base schema https://ns.adobe.com/xdm/common/extensible
- Audit Trail https://ns.adobe.com/xdm/common/auditable
- Person https://ns.adobe.com/xdm/context/person
- Address https://ns.adobe.com/xdm/common/address
- Email Address https://ns.adobe.com/xdm/context/emailaddress
- Phone Number https://ns.adobe.com/xdm/context/phonenumber
- OptInOut https://ns.adobe.com/xdm/context/optinout
- Organizational Unit https://ns.adobe.com/xdm/common/orgunit
- Geographical Unit https://ns.adobe.com/xdm/common/geounit

Profile Example

{
  "xdm:identities": [
    {
      "xdm:id": "someone@example.com",
      "xdm:namespace": {
        "xdm:code": "Email"
      }
    },
    {
      "xdm:id": "123-456",
      "xdm:namespace": {
        "xdm:code": "BB111"
      }
    }
  ],
  "xdm:person": {
    "xdm:name": {
      "xdm:givenName": "Jane",
      "xdm:middleName": "F",
      "xdm:surname": "Doe"
    },
    "xdm:birthMonth": 1,
    "xdm:birthDay": 3,
    "xdm:birthYear": 1996,
    "xdm:gender": "female"
  },
  "xdm:workAddress": {
    "@id": "https://data.adobe.io/entities/address/123",
    "xdm:primary": false,
    "xdm:street1": "345 Park Ave",
    "xdm:city": "San Jose",
    "xdm:stateProvince": "US-CA",
    "xdm:postalCode": "95110",
    "xdm:country": "United States",
    "xdm:countryCode": "US",
    "schema:latitude": 37.3382,
    "schema:longitude": 121.8863,
    "xdm:status": "active",
    "xdm:lastVerifiedDate": "2018-01-02"
  },
  "xdm:workEmail": {
    "xdm:primary": false,
    "xdm:address": "jsmith@xyzinc.com",
    "xdm:label": "John Smith",
    "xdm:type": "work",
    "xdm:status": "active"
  },
  "xdm:mobilePhone": {
    "xdm:primary": true,
    "xdm:number": "1-408-888-8888",
    "xdm:status": "active"
  },
  "xdm:optInOut": {
    "https://ns.adobe.com/xdm/channels/email": "pending",
    "https://ns.adobe.com/xdm/channels/phone": "out",
    "https://ns.adobe.com/xdm/channels/sms": "in",
    "https://ns.adobe.com/xdm/channels/fax": "not_provided",
    "https://ns.adobe.com/xdm/channels/direct-mail": "not_provided",
    "https://ns.adobe.com/xdm/channels/apns": "not_provided",
    "xdm:globalOptout": false
  },
  "xdm:orgUnit": {
    "@id": "https://data.adobe.io/org-apparals-men"
  },
  "xdm:geoUnit": {
    "@id": "https://data.adobe.io/geo-france"
  },
  "xdm:segments": [
    {
      "xdm:segmentID": {
        "@id": "https://data.adobe.io/entities/segmentidentity/04a81716-43d6-4e7a-a49c-f1d8b3129ba9",
        "xdm:namespace": {
          "xdm:code": "AAM"
        }
      },
      "xdm:version": "15",
      "xdm:timestamp": "2018-04-26T15:52:25+00:00",
      "xdm:validUntil": "2019-04-26T15:52:25+00:00",
      "xdm:status": "existing"
    },
    {
      "xdm:segmentID": {
        "@id": "https://data.adobe.io/entities/identity/53cba6b2-a23b-454a-8069-fc41308f1c0f",
        "xdm:namespace": {
          "xdm:code": "AAM"
        }
      },
      "xdm:version": "3",
      "xdm:lastQualificationTime": "2018-04-26T15:52:25+00:00",
      "xdm:validUntil": "2018-04-27T15:52:25+00:00",
      "xdm:status": "realized"
    }
  ]
}

Profile Properties

Property	Type	Required	Defined by
repo:createDate	`string`	Optional	Audit Trail
repo:lastModifiedDate	`string`	Optional	Audit Trail
xdm:createdByBatchID	`string`	Optional	Audit Trail
xdm:emailFormat	`string`	Optional	Profile (this schema)
xdm:faxPhone	Phone Number	Optional	Profile (this schema)
xdm:geoUnit	Geographical Unit	Optional	Profile (this schema)
xdm:homeAddress	Address	Optional	Profile (this schema)
xdm:homePhone	Phone Number	Optional	Profile (this schema)
xdm:identities	Identity	Optional	Profile (this schema)
xdm:mobilePhone	Phone Number	Optional	Profile (this schema)
xdm:modifiedByBatchID	`string`	Optional	Audit Trail
xdm:optInOut	OptInOut	Optional	Profile (this schema)
xdm:orgUnit	Organizational Unit	Optional	Profile (this schema)
xdm:organizations	`string[]`	Optional	Profile (this schema)
xdm:person	Person	Optional	Profile (this schema)
xdm:personalEmail	Email Address	Optional	Profile (this schema)
xdm:preferredLanguage	`string`	Optional	Profile (this schema)
xdm:profilePictureLink	`string`	Optional	Profile (this schema)
xdm:pushNotificationTokens	Push Notification Token	Optional	Profile (this schema)
xdm:repositoryCreatedBy	`string`	Optional	Audit Trail
xdm:repositoryLastModifiedBy	`string`	Optional	Audit Trail
xdm:segments	Segment Membership	Optional	Profile (this schema)
xdm:subscriptions	Subscription	Optional	Profile (this schema)
xdm:testProfile	`boolean`	Optional	Profile (this schema)
xdm:timeZone	`string`	Optional	Profile (this schema)
xdm:workAddress	Address	Optional	Profile (this schema)
xdm:workEmail	Email Address	Optional	Profile (this schema)
xdm:workPhone	Phone Number	Optional	Profile (this schema)
`*`	any	Additional	this schema allows additional properties

repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:createDate

is optional
type: string
defined in Audit Trail

repo:createDate Type

string

format: date-time – date and time (according to RFC 3339, section 5.6)

repo:createDate Example

"2004-10-23T12:00:00-06:00"

repo:lastModifiedDate

The server date and time when the resource was most recently modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:lastModifiedDate

is optional
type: string
defined in Audit Trail

repo:lastModifiedDate Type

string

format: date-time – date and time (according to RFC 3339, section 5.6)

repo:lastModifiedDate Example

"2004-10-23T12:00:00-06:00"

xdm:createdByBatchID

Created by Batch Identifier

The Data Set Files in Catalog Services which has been originating the creation of the entity.

xdm:createdByBatchID

is optional
type: string
defined in Audit Trail

xdm:createdByBatchID Type

string

format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:emailFormat

Email Format

Email format preferred by the profile. This can be rich text/plain text

xdm:emailFormat

is optional
type: string
defined in this schema

xdm:emailFormat Type

string

xdm:emailFormat Known Values

Value	Description
`html`	Rich text
`plaintext`	Plain text

xdm:faxPhone

Fax Phone

Fax phone number.

xdm:faxPhone

is optional
type: Phone Number
defined in this schema

xdm:faxPhone Type

Phone Number – https://ns.adobe.com/xdm/context/phonenumber

xdm:geoUnit

Geographical Unit

The geographical unit within the organization owning the profile. This can be used to reference the geographical information maintained in another dataset.

xdm:geoUnit

is optional
type: Geographical Unit
defined in this schema

xdm:geoUnit Type

Geographical Unit – https://ns.adobe.com/xdm/common/geounit

xdm:homeAddress

Home Address

A home postal address.

xdm:homeAddress

is optional
type: Address
defined in this schema

xdm:homeAddress Type

Address – https://ns.adobe.com/xdm/common/address

xdm:homePhone

Home Phone

Home phone number.

xdm:homePhone

is optional
type: Phone Number
defined in this schema

xdm:homePhone Type

Phone Number – https://ns.adobe.com/xdm/context/phonenumber

xdm:identities

All User Identities

Array of Identities. Condensed, normalized encapsulation of all end user identifiers.

xdm:identities

is optional
type: Identity
at least 1 items in the array
defined in this schema

xdm:identities Type

Array type: Identity

All items must be of the type:

Identity – https://ns.adobe.com/xdm/context/identity

xdm:mobilePhone

Mobile Phone

Mobile phone number.

xdm:mobilePhone

is optional
type: Phone Number
defined in this schema

xdm:mobilePhone Type

Phone Number – https://ns.adobe.com/xdm/context/phonenumber

xdm:modifiedByBatchID

Modified by Batch Identifier

The last Data Set Files in Catalog Services which has modified the entity. At creation time, modifiedByBatchID is set as createdByBatchID.

xdm:modifiedByBatchID

is optional
type: string
defined in Audit Trail

xdm:modifiedByBatchID Type

string

format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:optInOut

OptInOut

Describes a users opting in and out preferences for communication by medium and communication type.

xdm:optInOut

is optional
type: OptInOut
defined in this schema

xdm:optInOut Type

OptInOut – https://ns.adobe.com/xdm/context/optinout

xdm:orgUnit

Organizational Unit

The unit within the organization owning the profile. This can be used to reference the organization details maintained in another dataset.

xdm:orgUnit

is optional
type: Organizational Unit
defined in this schema

xdm:orgUnit Type

Organizational Unit – https://ns.adobe.com/xdm/common/orgunit

xdm:organizations

Organizations

xdm:organizations

is optional
type: string[]
defined in this schema

xdm:organizations Type

Array type: string[]

All items must be of the type: string

xdm:person

Person

An individual actor, contact, or owner.

xdm:person

is optional
type: Person
defined in this schema

xdm:person Type

Person – https://ns.adobe.com/xdm/context/person

xdm:personalEmail

Personal Email

A personal email address.

xdm:personalEmail

is optional
type: Email Address
defined in this schema

xdm:personalEmail Type

Email Address – https://ns.adobe.com/xdm/context/emailaddress

xdm:preferredLanguage

Preferred Language

Describes the preferred system of communication used by the profile. Language codes are expressed in BCP 47 format.

xdm:preferredLanguage

is optional
type: string
defined in this schema

xdm:preferredLanguage Type

string

All instances must conform to this regular expression

^(((([A-Za-z]{2,3}(-([A-Za-z]{3}(-[A-Za-z]{3}){0,2}))?)|[A-Za-z]{4}|[A-Za-z]{5,8})(-([A-Za-z]{4}))?(-([A-Za-z]{2}|[0-9]{3}))?(-([A-Za-z0-9]{5,8}|[0-9][A-Za-z0-9]{3}))*(-([0-9A-WY-Za-wy-z](-[A-Za-z0-9]{2,8})+))*(-(x(-[A-Za-z0-9]{1,8})+))?)|(x(-[A-Za-z0-9]{1,8})+)|((en-GB-oed|i-ami|i-bnn|i-default|i-enochian|i-hak|i-klingon|i-lux|i-mingo|i-navajo|i-pwn|i-tao|i-tay|i-tsu|sgn-BE-FR|sgn-BE-NL|sgn-CH-DE)|(art-lojban|cel-gaulish|no-bok|no-nyn|zh-guoyu|zh-hakka|zh-min|zh-min-nan|zh-xiang)))$

test example: en-GB
test example: de-DE
test example: yue-HK

xdm:preferredLanguage Examples

"en-GB"

"de-DE"

"yue-HK"

xdm:profilePictureLink

Profile Picture Link

Link to profile's picture

xdm:profilePictureLink

is optional
type: string
defined in this schema

xdm:profilePictureLink Type

string

xdm:pushNotificationTokens

Push Notification Tokens

Push notification tokens are used to communicate with applications that are installed on devices or SaaS application accounts.

xdm:pushNotificationTokens

is optional
type: Push Notification Token
defined in this schema

xdm:pushNotificationTokens Type

Array type: Push Notification Token

All items must be of the type:

Push Notification Token – https://ns.adobe.com/xdm/context/pushnotificationtoken

xdm:repositoryCreatedBy

Created by User Identifier

User id who has created the entity.

xdm:repositoryCreatedBy

is optional
type: string
defined in Audit Trail

xdm:repositoryCreatedBy Type

string

xdm:repositoryLastModifiedBy

Modified by User Identifier

User id who last modified the entity. At creation time, modifiedByUser is set as createdByUser.

xdm:repositoryLastModifiedBy

is optional
type: string
defined in Audit Trail

xdm:repositoryLastModifiedBy Type

string

xdm:segments

Segment Membership

xdm:segments

is optional
type: Segment Membership
defined in this schema

xdm:segments Type

Array type: Segment Membership

All items must be of the type:

Segment Membership – https://ns.adobe.com/xdm/context/segmentmembership

xdm:subscriptions

Subscriptions

Subscriptions that this profile is entitled to including terminated, expired or exhausted subscriptions.

xdm:subscriptions

is optional
type: Subscription
defined in this schema

xdm:subscriptions Type

Array type: Subscription

All items must be of the type:

Subscription – https://ns.adobe.com/xdm/context/subscription

xdm:testProfile

Test Profile

Indicates the profile record is for use in testing/verification purposes and should not be automatically included in normal operation(s).

xdm:testProfile

is optional
type: boolean
defined in this schema

xdm:testProfile Type

boolean

xdm:timeZone

Time Zone

Describes which time zone the profile is present in, most frequently/the time zone preferred by the profile. Time zones are expressed according to the IETF tz database: https://www.ietf.org/timezones/tzdb-2016i/tz-link.htm

xdm:timeZone

is optional
type: string
defined in this schema

xdm:timeZone Type

string

xdm:timeZone Examples

"America/Barbados"

"Antarctica/Davis"

"Asia/Calcutta"

xdm:workAddress

Work Address

A work postal address.

xdm:workAddress

is optional
type: Address
defined in this schema

xdm:workAddress Type

Address – https://ns.adobe.com/xdm/common/address

xdm:workEmail

Work Email

A work email address.

xdm:workEmail

is optional
type: Email Address
defined in this schema

xdm:workEmail Type

Email Address – https://ns.adobe.com/xdm/context/emailaddress

xdm:workPhone

Work Phone

Work phone number.

xdm:workPhone

is optional
type: Phone Number
defined in this schema

xdm:workPhone Type

Phone Number – https://ns.adobe.com/xdm/context/phonenumber

Files

profile.schema.md

Latest commit

History

profile.schema.md

File metadata and controls

Profile Schema

Schema Hierarchy

Profile Example

Profile Properties

repo:createDate

repo:createDate Type

repo:createDate Example

repo:lastModifiedDate

repo:lastModifiedDate Type

repo:lastModifiedDate Example

xdm:createdByBatchID

Created by Batch Identifier

xdm:createdByBatchID Type

xdm:emailFormat

Email Format

xdm:emailFormat Type

xdm:emailFormat Known Values

xdm:faxPhone

Fax Phone

xdm:faxPhone Type

xdm:geoUnit

Geographical Unit

xdm:geoUnit Type

xdm:homeAddress

Home Address

xdm:homeAddress Type

xdm:homePhone

Home Phone

xdm:homePhone Type

xdm:identities

All User Identities

xdm:identities Type

xdm:mobilePhone

Mobile Phone

xdm:mobilePhone Type

xdm:modifiedByBatchID

Modified by Batch Identifier

xdm:modifiedByBatchID Type

xdm:optInOut

OptInOut

xdm:optInOut Type

xdm:orgUnit

Organizational Unit

xdm:orgUnit Type

xdm:organizations

Organizations

xdm:organizations Type

xdm:person

Person

xdm:person Type

xdm:personalEmail

Personal Email

xdm:personalEmail Type

xdm:preferredLanguage

Preferred Language

xdm:preferredLanguage Type

xdm:preferredLanguage Examples

xdm:profilePictureLink

Profile Picture Link

xdm:profilePictureLink Type

xdm:pushNotificationTokens

Push Notification Tokens

xdm:pushNotificationTokens Type

xdm:repositoryCreatedBy

Created by User Identifier

xdm:repositoryCreatedBy Type

xdm:repositoryLastModifiedBy

Modified by User Identifier

xdm:repositoryLastModifiedBy Type

xdm:segments

Segment Membership

xdm:segments Type

xdm:subscriptions

Subscriptions