Person

This is the main profile object containing data about the user/guest as a person.

Property	Type	Description
ipAddress	string	IP-address of the device the person used last
givenName	string
additionalName	string	Middle name
familyName	string
displayName	string
alternateName	string	nickname: can set freely by the user
address	PostalAddress
email	string	^[a-zA-Z0-9.!#$%&’'+/=?^_`\|}{~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)$ is used for email validation
faxNumber	string
gender	string	Female, Male, Diverse
nationality	string	ISO 3166 two-letter uppercase subculture code. In cases where a two-letter language code is not available, a three-letter code derived from ISO 639-2 is used
birthDate	DateTime(nullable)
telephone	string
maritialStatus	string	Single, Married, Divorced, Widowed
passport	string(100)	Passport number
mobilePhone	string
salutation	string	see below
preferredLanguage	string	preferred language of the user
hasProfileImage	bool	indicator if the user has a profile image
profileImage	string	link to retrieve the profile image
hasVerifiedEmail	bool	indicator if the email address of the user is verified
verificationLevel	string	level of account verification
identificationLevel	string	account identification level. Possible values: Guest, EmailNotVerified and EmailVerified
HasPrivateEmail	bool	an indicator if the person is using a private email address e.g. Apple Private Relay address
reduction	string	reduction following the SBB definitions: bc100, bc25, bc50, ga-1^st, ga-2^nd, half-fare, junior-card, child-card, none, rail-plus, swiss-half-fare-card, swiss-travel-pass
state	string	Person State: - Active - PendingAcceptance if a user was invited - PendingDeletion - Deleted

The "Salutation" value is parsed and saved as the English abbrevations (header row) which we always return. This means you can send any value out of the table below (with or without . and in any caption), but we will return the values in the header.

values	Mr	Mrs	Child	Other
en	Mr. / Mister	Mrs. / Miss	Child	not null or empty
de	Hr. / Herr	Fr. / Frau	Kind	not null or empty
fr	M. / Monsieur	Mme./ Madame	Enfant	not null or empty
it	Sig. / Signor / Senor / Signore	sig.ra. / Signora	Bambino	not null or empty
es	Sr. / Señor	Sra. / Señora / Dona	Niño	not null or empty

Included base profile object data¶

Property	Type	Description
profileId	string	Readonly. Identifier. Guid generated at the creation of the profile
@id	string	json-ld: full url to load the object
createdDateTime	DateTime	date and time when the object was created
lastModified	DateTime	date and time when the object was last updated
lastModifiedBy	string	the person/service which has last updated the object authenticated users: username of Azure B2C guests: profile id
createdBySubscription	string	the api subscription name of the creation (→ application)
lastModifiedBySubscription	string	the api subscription name on the latest update

Last update: July 7, 2022 17:56:04