JSContact: A JSON representation of contact data

1.3.1. Objects and Properties

JSContact defines data types for contact information such as addresses or names. This information typically consists of multiple related elements, for example a personal name and surname together form a name. These related elements are organized in JSContact objects. A JSContact object is a JSON object which:¶

1. Has a unique type name registered in the IANA JSContact Types Registry (Section 4.6).¶
2. Has one or more object members for which the name and allowed value types are specified. Such members are called "properties".¶
3. Has one property named @type with a string value that matches the type name of this JSContact object. In general, this property does not need to be set explicitly as outlined in Section 1.3.4.¶

The following sections specify how to define JSContact object types. Section 1.7 and Section 1.8 then define the exact requirements for property names.¶

The next paragraph illustrates how a JSContact object is defined:¶

A Foo object has the following properties:¶

• qux: Number (mandatory). Defines the qux-ishness of this contact. The value MUST be an integer greater than 0 and less than 10.¶

Here, a JSContact object type named Foo is defined. In addition to its @type property it has a property named qux for which values MUST be valid according to the definition of the Number type. The property has one attribute, mandatory, which specifies that the property MUST be present for an instance of this JSContact object to be valid. Finally, a free-text description describes the semantics and further restrictions.¶

1.3.2. Type Signatures

Type signatures are given for all JSON values and JSContact definitions in this document. The following conventions are used:¶

• String - The JSON string type.¶
• Number - The JSON number type.¶
• Boolean - The JSON boolean type.¶
• A[B] - A JSON object where the keys are all of the type A, and the values are all of the type B.¶
• A[] - A JSON array of values of type A.¶
• A|B - The value is either of type A or of type B.¶
• * - The type is undefined (the value could be any type, although permitted values may be constrained by the context of this value).¶

Section 1.4 defines common data types, including signed or unsigned integers and dates.¶

1.3.3. Property Attributes

Object properties may also have a set of attributes defined along with the type signature. These have the following meanings:¶

• mandatory: The property MUST be set for an instance of this object to be valid.¶
• optional: The property can but not need be set for an instance of this object to be valid.¶
• default: This is followed by a JSON value. That value will be used for this property if it is omitted.¶
• defaultType: This is followed by the name of a JSContact object type. A property value of JSContact object type is expected to be of this named type, in case it omits the @type property.¶

1.3.4. The @type Property

This property is defined as:¶

• @type: String. Specifies the type of this object. This MUST match the type name of the JSContact object of which this JSON object is an instance of.¶

The purpose of this property is to help implementations identify which JSContact object type a given JSON object represents. Implementations MUST validate that JSON objects with this property conform to the specification of the JSContact object type of that name.¶

In many cases the @type property value is implied by where its object occurs in JSContact data. Assuming that both A and B are JSContact object types:¶

• An object that is set as the value for a property with type signature A MAY have the @type property set. If the @type property is not set then its value is implied to be A by the property definition.¶
• An object that is set as the value for a property with type signature A|B (defaultType: A) MAY have the @type property set if it is an instance of A. It MUST have the @type property set if it is an instance of B. If instead the defaultType attribute is not defined then the @type property MUST also be set for A.¶
• An object that is not the value of a property, such at the root of JSON data (directly or as member of an array), MUST have the @type property set.¶

1.4.1. Id

Where Id is given as a data type, it means a String of at least 1 and a maximum of 255 octets in size, and it MUST only contain characters from the URL and Filename Safe base64url alphabet, as defined in Section 5 of [RFC4648], excluding the pad character (=). This means the allowed characters are the ASCII alphanumeric characters (A-Za-z0-9), hyphen (-), and underscore (_).¶

In many places in JSContact a JSON map is used where the map keys are of type Id and the map values are all the same type of object. This construction represents an unordered set of objects, with the added advantage that each entry has a name (the corresponding map key). This allows for more concise patching of objects, and, when applicable, for the objects in question to be referenced from other objects within the JSContact object. The map keys MUST be preserved across multiple versions of the JSContact object.¶

Unless otherwise specified for a particular property, there are no uniqueness constraints on an Id value (other than, of course, the requirement that you cannot have two values with the same key within a single JSON map). For example, two Card (Section 2) objects might use the same Ids in their respective photos properties. Or within the same Card the same Id could appear in the emails and phones properties. These situations do not imply any semantic connections among the objects.¶

1.4.2. Int and UnsignedInt

Where Int is given as a data type, it means an integer in the range -2⁵³+1 <= value <= 2⁵³-1, the safe range for integers stored in a floating-point double, represented as a JSON Number.¶

Where UnsignedInt is given as a data type, it means an integer in the range 0 <= value <= 2⁵³-1, represented as a JSON Number.¶

1.4.3. PatchObject

A PatchObject is of type String[*], and represents an unordered set of patches on a JSON object. Each key is a path represented in a subset of JSON pointer format [RFC6901]. The paths have an implicit leading /, so each key is prefixed with / before applying the JSON pointer evaluation algorithm.¶

A patch within a PatchObject is only valid if all the following conditions apply:¶

1. The pointer MUST NOT reference inside an array (i.e., you MUST NOT insert/delete from an array; the array MUST be replaced in its entirety instead).¶
2. All parts prior to the last (i.e., the value after the final slash) MUST already exist on the object being patched.¶
3. There MUST NOT be two patches in the PatchObject where the pointer of one is the prefix of the pointer of the other, e.g., addresses/1/city and addresses.¶
4. The value for the patch MUST be valid for the property being set (of the correct type and obeying any other applicable restrictions), or if null the property MUST be optional.¶

The value associated with each pointer determines how to apply that patch:¶

• If null, remove the property from the patched object. If the key is not present in the parent, this a no-op.¶
• If non-null, set the value given as the value for this property (this may be a replacement or addition to the object being patched).¶

A PatchObject does not define its own @type (Section 1.3.4) property. Instead, a @type property in a patch MUST be handled as any other patched property value.¶

Implementations MUST reject in its entirety a PatchObject if any of its patches are invalid. Implementations MUST NOT apply partial patches.¶

1.4.4. Resource

This data type defines a resource associated with the entity represented by this Card, identified by a URI [RFC3986]. Several property definitions later in this document refer to the Resource data type as the basis for their property-specific value types. The Resource data type defines the properties that are common to all of them. Property definitions making use of Resource MAY define additional properties for their value types.¶

The @type property value MUST NOT be Resource, instead it MUST be the name of a concrete resource type (see Section 2.6). A Resource object has the following properties.¶

• @type: String. Specifies the type of this resource object. The allowed value is defined in later sections of this document for each concrete resource type (Section 2.6).¶

• kind: String (optional). The kind of the resource. The allowed values are defined in the property definition that makes use of the Resource type.¶

• uri: String (mandatory). The resource value. This MUST be a URI as defined in Section 3 of [RFC3986] and updates.¶
• mediaType: String (optional). Used for URI resource values. Provides the media type [RFC2046] of the resource identified by the URI.¶
• contexts: String[Boolean] (optional). The contexts in which to use this resource. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). The preference of this resource in relation to other resources. Also see Section 1.5.3.¶
• label: String (optional). A custom label for the value, see Section 1.5.2.¶

1.4.5. UTCDateTime

This is a string in [RFC3339] date-time format, with the further restrictions that any letters MUST be in uppercase, and the time offset MUST be the character Z. Fractional second values MUST NOT be included unless non-zero and MUST NOT have trailing zeros, to ensure there is only a single representation for each date-time.¶

For example, 2010-10-10T10:10:10.003Z is conformant, but 2010-10-10T10:10:10.000Z is invalid and is correctly encoded as 2010-10-10T10:10:10Z.¶

1.5.1. The contexts Property

Type: String[Boolean]¶

This property associates contact information with one or more contexts in which it should be used. For example, someone might have distinct phone numbers for work and private contexts, and may set the desired context on the respective phone number in the phones (Section 2.3.3) property.¶

This section defines common contexts. Additional contexts may be defined in the properties or data types that make use of this property. The enumerated (Section 1.7.3) common context values are:¶

• private: The contact information may be used to contact in a private context.¶
• work: The contact information may be used to contact in a professional context.¶

1.5.2. The label Property

Type: String¶

This property allows associating contact data with user-defined labels. Such labels may be set for phone numbers, email addresses and resources. Typically, these labels are displayed along with their associated contact data in graphical user interfaces. Such labels best be succinct to properly display on small graphical interfaces and screens.¶

1.5.3. The pref Property

Type: UnsignedInt¶

This property allows defining a preference order for contact information. For example, a person may have two email addresses and prefer to be contacted with one of them.¶

Its value MUST be in the range 1 and 100. Lower values correspond to a higher level of preference, with 1 being most preferred. If no preference is set, then the contact information MUST be interpreted as being least preferred.¶

Note that the preference only is defined in relation to contact information of the same type. For example, the preference orders within emails and phone numbers are independent of each other.¶

1.5.4. The pronounce Property

Type: Pronounce¶

This property defines how to pronounce a value in the language indicated in the Card language (Section 2.1.5) property or the language tag of its localizations (Section 2.7.1). Exemplary uses are to define how to pronounce Japanese names, or for romanization of Mandarin or Cantonese name and address components. A Pronounce object has the following properties:¶

• @type: String. This MUST be "Pronounce"", if set.¶

• phonetics: String (mandatory). Contains the phonetic representation of a value. The script or phonetic system used SHOULD be indicated in the script or system property. Any script language subtag in the Card language (Section 2.1.5) property MUST be ignored for use with the phonetics property.¶

• script: String (optional). The script used for value of the phonetics property. This MUST be a valid script subtag as defined in Section 2.2.3 of [RFC5646].¶

• system: String (optional). The phonetic system used for the value of the phonetics property. This MAY be any string, but this specification reserves the following enumerated values (Section 1.7.3):¶

  • ipa: denotes the International Phonetic Alphabet [IPA].¶
  • piny: denotes the Standard Mandarin romanization system "Hanyu Pinyin".¶
  • jyut: denotes the Cantonese romanization system "Jyutping".¶

The following example shows how to define pronunciation for a surname (Section 2.2.1):¶

{
  "kind": "surname",
  "value": "Smith",
  "pronounce": {
    "phonetics": "/smɪθ/",
    "system": "ipa"
  }
}

1.6.2. Current Version

This specification registers JSContact version value 1.0 (Table 1).¶

1.7.1. IANA-registered Properties

An IANA-registered property is any property that has been registered according to the IANA property registry rules as outlined in Section 4. All properties defined in this specification, including their object value types and enumerated values, are registered at IANA.¶

Implementations MUST validate IANA-registered properties in JSContact data, unless they are unknown to the implementation (see Section 1.7.2). They MUST reject invalid IANA-registered properties. A property is invalid if its name matches the name of an IANA-registered property but the value violates its definition according to the JSContact specification version defined in the Card version property (Section 2.1.2).¶

IANA-registered property names MUST NOT contain US-ASCII control characters (U+0000 to U+001F, U+007F), the COLON (U+003A) or QUOTATION MARK (U+0022) characters. They MUST only contain US-ASCII alphanumeric characters that match the ALPHA and DIGIT rules defined in Appendix B.1 of [RFC5234]) or the COMMERCIAL AT (U+0040) character. IANA-registered property names MUST be notated in lower camel case.¶

1.7.2. Unknown Properties

Implementations may encounter JSContact data where a property name is unknown to that implementation, but the name adheres to the syntactic restrictions of IANA-registered property names. Implementations MUST NOT treat such properties as invalid. Instead, they MUST preserve them in the JSContact object. Implementations that create or update JSContact data MUST only set IANA-registered properties or vendor-specific properties. Preserving properties that are unknown to the implementation, is to allow applications and services to interoperate without data loss, even if not all of them implement the same set of JSContact extensions.¶

1.7.3. Enumerated Values

Several properties in this document restrict their allowed values to be from a list of String values. These values are case-sensitive. If not noted otherwise for a specific property, the initial list of values for such properties is registered at IANA in the JSContact Enum Values Registry (Section 4.7). Implementations MUST only set IANA-registered or vendor-specific (Section 1.8.2) values for such properties.¶

1.8.1. Vendor-specific Properties

Vendor-specific property names MUST start with a vendor-specific prefix followed by a name, as produced by the v-extension ABNF below. The vendor-specific prefix MUST be a domain name under control of the service or application that sets the property, but it need not resolve in the Domain Name System [RFC1034] and [RFC1035]. The prefix ietf.org and its subdomain names are reserved for IETF specifications. The name MUST NOT contain the TILDE (U+007E) and SOLIDUS (U+002F) characters, as these require special-escaping when encoding a JSON Pointer [RFC6901] for that property.¶

Vendor-specific properties MAY be set in any JSContact object. Implementations MUST preserve vendor-specific properties in JSContact data, irrespective if they know their use. They MUST NOT reject the property value as invalid, unless they are in control of the vendor-specific property as outlined in the above paragraph.¶

The ABNF rule v-extension formally defines valid vendor-specific property names. Note that the vendor prefix allows for more values than are allowed as Internationalized Domain Names (IDN) [RFC8499]. This is to allow JSContact implementations simply validate property names without implementing the full set of rules that apply to domain names.¶

v-extension = v-prefix ":" v-name

v-prefix = v-label *("." v-label)

v-label = alnum-int / alnum-int *(alnum-int / "-") alnum-int

alnum-int = ALPHA / DIGIT / NON-ASCII
  ; see RFC 6350 Section 3.3

v-name = 1*(WSP / "!" / %x23-2e / %x30-7d / NON-ASCII)
  ; any characters except CTLs, DQUOTE, SOLIDUS and TILDE

The value of vendor-specific properties can be any valid JSON value, and naming restrictions do not apply to such values. Specifically, if the property value is a JSON object then the keys of such objects need not be named as vendor-specific properties. The example in Figure 3 illustrates this:¶

"example.com:foo": "bar",
"example.com:foo2": {
  "bar": "baz"
}

1.8.2. Vendor-specific Values

Some JSContact IANA-registered properties allow their values to be vendor-specific. One such example is the kind property Section 2.1.4, which enumerates its standard values but also allows for arbitrary vendor-specific values. Such vendor-specific values MUST be valid v-extension values as defined in Section 1.8.1. The example in Figure 4 illustrates this:¶

"kind": "example.com:baz"

Vendors are strongly encouraged to specify a new standard value once a vendor-specific one turns out to be useful also for other systems.¶

2.1.1. @type

Type: String (mandatory).¶

This MUST be Card, if set.¶

2.1.2. version

Type: String (mandatory).¶

Specifies the JSContact version used to define this Card. The value MUST be one of the IANA-registered JSContact Enum Values for the version property. Also see Section 1.6.2.¶

"version": "1.0"

2.1.3. created

Type: UTCDateTime (optional).¶

The date and time when this Card was created.¶

"created": "2022-09-30T14:35:10Z",

2.1.4. kind

Type: String (optional). The kind of the entity the Card represents.¶

The enumerated (Section 1.7.3) values are:¶

• individual: a single person¶
• group: a group person of persons or entities¶
• org: an organization¶
• location: a named location¶
• device: a device, such as appliances, computers, or network elements¶
• application: a software application¶

"kind": "individual",

2.1.5. language

Type: String (optional).¶

This is the language tag, as defined in [RFC5646], that best describes the language used for text in the Card, optionally including additional information such as the script. Note that values MAY be localized in the localizations property Section 2.7.1. How to render text is out of scope of this specification, e.g., refer to [UnicodeBiDi] how to deal with different writing directions.¶

"language": "de-AT",

2.1.6. members

Type: String[Boolean] (optional).¶

This identifies the set of Cards that are members of this group Card. Each key in the set is the uid property value of the member, each boolean value MUST be true. If this property is set, then the value of the kind property MUST be group.¶

The opposite is not true. A group Card will usually contain the members property to specify the members of the group, but it is not required to. A group Card without the members property can be considered an abstract grouping, or one whose members are known empirically (e.g., "IETF Participants").¶

"kind": "group",
"name": {
  "full": "The Doe family"
},
"uid": "urn:uuid:ab4310aa-fa43-11e9-8f0b-362b9e155667",
"members": {
  "urn:uuid:03a0e51f-d1aa-4385-8a53-e29025acd8af": true,
  "urn:uuid:b8767877-b4a1-4c70-9acc-505d3819e519": true
}

2.1.7. prodId

Type: String (optional).¶

The identifier for the product that created the Card. If set, the value MUST be at least one character long.¶

"prodId": "ACME Contacts App version 1.23.5"

2.1.8. relatedTo

Type: String[Relation] (optional).¶

Relates the object to other Cards. This is represented as a map, where each key is the uid of the related Card and the value defines the relation. The Relation object has the following properties:¶

• @type: String. This MUST be Relation, if set.¶

• relation: String[Boolean] (optional, default: empty Object) Describes how the linked object is related to the linking object. The relation is defined as a set of relation types. The key in the set defines the relation type, the value for each key in the set MUST be true. The relationship between the two objects is undefined if the set is empty.¶

  The initial list of enumerated (Section 1.7.3) relation types matches the IANA-registered TYPE parameter [IANAvCard] values of the vCard RELATED property (Section 6.6.6 of [RFC6350]):¶

  • acquaintance¶
  • agent¶
  • child¶
  • colleague¶
  • contact¶
  • co-resident¶
  • co-worker¶
  • crush¶
  • date¶
  • emergency¶
  • friend¶
  • kin¶
  • me¶
  • met¶
  • muse¶
  • neighbor¶
  • parent¶
  • sibling¶
  • spouse¶
  • sweetheart¶

"relatedTo": {
  "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6": {
    "relation": {
      "friend": true
    }
  },
  "8cacdfb7d1ffdb59@example.com": {
    "relation": {}
  }
}

2.1.9. uid

Type: String (mandatory).¶

An identifier, used to associate the object as the same across different systems, address books and views. The value SHOULD be a URN [RFC8141] but for compatibility with [RFC6350] it MAY also be a URI [RFC3986] or free-text value. The value of the URN SHOULD be in the uuid namespace [RFC4122]. As of this writing, a revision [I-D.ietf-uuidrev-rfc4122bis] of the UUID standard document is being worked on and is likely to introduce new UUID versions and best practices to generate global unique identifiers. Implementors SHOULD follow any recommendations described there. Until then, implementations SHOULD generate identifiers using the random or pseudo-random UUID version described in Section 4.4 of [RFC4122].¶

"uid": "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6"

2.1.10. updated

Type: UTCDateTime (optional).¶

The date and time when the data in this Card was last modified.¶

"updated": "2021-10-31T22:27:10Z"

2.2.1. name

Type: Name (optional).¶

The name of the entity represented by this Card. This can be any type of name, e.g., it can but need not be the legal name of a person.¶

A Name object has the following properties¶

• @type: String. This MUST be Name, if set.¶

• components: NameComponent[] (optional). The components making up the name. The component list MUST have at least one entry. This property SHOULD be set, and it MUST be set if the full property is not set.¶

  Name components SHOULD be ordered such that their values joined as a String produce a valid full name of this entity. The defaultSeparator property and name components of kind separator give guidance what characters to insert between components, but implementations are free to choose any others. In lack of a separator, inserting a single Space character in between name component values is a good choice.¶

  Figure 15 is an example for the name "Vincent van Gogh". Note how a single name component value may consist of multiple words. Figure 16 illustrates a name with a second surname, such as a Spanish name. Additional examples are Figure 18 and Figure 37.¶

  "components": [
    { "kind": "given", "value": "Vincent" },
    { "kind": "surname", "value": "van Gogh" }
  ]
  

  "components": [
    { "kind": "given", "value": "Diego" },
    { "kind": "surname", "value": "Rivera" },
    { "kind": "surname2", "value": "Barrientos" }
  ]
  

• defaultSeparator: String (optional). The default separator to insert between name component values when concatenating all name component values to a single String. Also see the definition of the separator kind for the NameComponent object.¶

• full: String (optional). This is the full name representation of this Name. The purpose of this property is to define a name even if the individual name components are not known. This property SHOULD NOT be set, but it MUST be set if the components property is not set.¶

  "full": "Mr. John Q. Public, Esq."
  

• pronounce: Pronounce (optional). This defines how to pronounce this name, e.g., a full name. Also see Section 1.5.4.¶

• sortAs: String[String] (optional).¶

  This defines how this name lexicographically sorts in relation to other names when compared by a name component type. The key in the map defines the name component type. The value for that key defines the verbatim string to compare when sorting by this name component type. Absence of a key indicates that this name component type should not be considered during sort. Sorting by that missing name component type or if the sortAs property is not set is implementation-specific.¶

  Each key in the map MUST be a valid name component type value as defined for the kind property of the NameComponent object (see below). For each key in the map there MUST exist at least one NameComponent object having that type in the components property of this name.¶

  Figure 18 illustrates the use of sortAs. The property value indicates that the middle name followed by both surnames should be used when sorting this name by surname. The absence of the middle indicates that the middle name on its own should be disregarded during sort. Even though the name only contains one name component for the given name, the sortAs property still explicitly defines how to sort by given name as otherwise sorting by it would be undefined.¶

  "name": {
    "components": [
      { "kind": "given", "value": "Robert" },
      { "kind": "middle", "value": "Pau" },
      { "kind": "surname", "value": "Shou Chang" }
    ],
    "sortAs": {
      "surname": "Pau Shou Chang",
      "given": "Robert"
    }
  }
  

A NameComponent object has the following properties:¶

• @type: String. This MUST be NameComponent, if set.¶
• value: String (mandatory). The value of this name component. This can be composed of one or multiple words, such as "Poe" or "van Gogh".¶

• kind: String (mandatory). The kind of this name component. The enumerated (Section 1.7.3) values are:¶

  • title. The value is an honorific title or prefix, e.g., "Mr", "Ms", "Dr".¶
  • given. The value is a given name, also known as "first name", "personal name".¶
  • surname. The value is a surname, also known as "last name", "family name".¶
  • surname2. The value is a secondary surname (used in some cultures), also known as "maternal surname".¶
  • middle. The value is a middle name, also known as "additional given name".¶
  • credential. The value is a credential, also known as "accreditation qualifier" or "honorific suffix", e.g., "B.A.", "Esq.".¶
  • generation. The value is a generation marker or qualifier, e.g., "Jr." or "III".¶
  • separator. A formatting separator for two name components. The value property of the component includes the verbatim separator, for example a hyphen character or even an empty string. This value has higher precedence than the defaultSeparator property of the Name.¶
• pronounce: Pronounce (optional). This defines how to pronounce this name component. Also see Section 1.5.4.¶

2.2.2. nickNames

Type: Id[NickName] (optional).¶

The nicknames of the entity represented by this Card. A NickName object has the following properties:¶

• @type: String. This MUST be NickName, if set.¶
• name: String (mandatory). The nickname.¶
• contexts: String[Boolean] (optional) The contexts in which to use this nickname. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). The preference of this nickname in relation to other nicknames. Also see Section 1.5.3.¶

"nickNames": {
  "k391": {
    "name": "Johnny"
  }
}

2.2.3. organizations

Type: Id[Organization] (optional).¶

The companies or organization names and units associated with this Card. An Organization object has the following properties, of which at least one of the name and units properties MUST be set:¶

• @type: String. This MUST be Organization, if set.¶
• name: String (optional). The name of this organization.¶
• units: OrgUnit[] (optional). A list of organizational units, ordered descending by hierarchy (e.g., a geographic or functional division sorts before a department within that division). If set, the list MUST contain at least one entry.¶
• sortAs: String (optional). This defines how this organization name lexicographically sorts in relation to other organizations when compared by name. The value defines the verbatim string value to compare. In absence of this property, the name property value MAY be used for comparison.¶
• contexts: String[Boolean] (optional). The contexts in which association with this organization apply. For example, membership in a choir may only apply in a private context. Also see Section 1.5.1.¶

A OrgUnit object has the following properties:¶

• @type: String. This MUST be OrgUnit, if set.¶
• name: String (mandatory). The name of this organizational unit.¶
• sortAs: String (optional). This defines how this organization unit name lexicographically sorts in relation to other organizational units of the same level when compared by name. The level is defined by the array index of this organizational unit in the units property of the Organization object. The property value defines the verbatim string value to compare. In absence of this property, the name property value MAY be used for comparison.¶

"organizations": {
  "o1": {
    "name": "ABC, Inc.",
    "units": [
      { "name": "North American Division" },
      { "name": "Marketing" }
    ],
    "sortAs": "ABC"
  }
}

2.2.4. speakToAs

Type: SpeakToAs (optional).¶

Provides information how to address, speak to or refer to the entity that is represented by this Card. A SpeakToAs object has the following properties, of which at least one of the grammaticalGender and pronouns properties MUST be set:¶

• @type: String. This MUST be SpeakToAs, if set.¶

• grammaticalGender: String (optional). Defines which grammatical gender to use in salutations and other grammatical constructs. For example, the German language distinguishes by grammatical gender in salutations such as "Sehr geehrte" (feminine) and "Sehr geehrter" (masculine). The enumerated (Section 1.7.3) values are:¶

  • animate¶
  • common¶
  • feminine¶
  • inanimate¶
  • masculine¶
  • neuter¶

  Note that the grammatical gender does not allow inferring the gender identities or assigned sex of the contact.¶

• pronouns: Id[Pronouns] (optional). Defines the pronouns that the contact chooses to use for themselves.¶

A Pronouns object has the following properties:¶

• @type: String. This MUST be Pronouns, if set.¶
• pronouns: String (mandatory). Defines the pronouns. Any value or form is allowed. Examples in English include she/her and they/them/theirs. The value MAY be overridden in the localizations property (Section 2.7.1).¶
• contexts: String[Boolean] (optional). The contexts in which to use these pronouns. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). The preference of these pronouns in relation to other pronouns in the same context. Also see Section 1.5.3.¶

"speakToAs": {
  "grammaticalGender": "neuter",
  "pronouns": {
    "k19": {
      "pronouns": "they/them",
      "pref": 2
    },
    "k32": {
      "pronouns": "xe/xir",
      "pref": 1
    }
  }
}

2.2.5. titles

Type : Id[Title] (optional).¶

The job titles or functional positions of the entity represented by this Card. A Title object has the following properties:¶

• @type: String. This MUST be Title, if set.¶
• name: String (mandatory). The title or role name of the entity represented by this Card.¶

• kind: String (optional, default title). Describes the organizational or situational kind of this title. Some organizations and individuals distinguish between titles as organizational positions and roles as more temporary assignments, such as in project management.¶

  The enumerated (Section 1.7.3) values are:¶

  • title¶
  • role¶
• organization: Id (optional). The identifier of the organization in which this title is held.¶

"titles": {
  "le9": {
    "kind": "title",
    "name": "Research Scientist"
  },
  "k2": {
    "kind": "role",
    "name": "Project Leader",
    "organization": "o2"
  }
},
"organizations": {
  "o2": {
    "name": "ABC, Inc."
  }
}

2.3.1. emails

Type: Id[EmailAddress] (optional).¶

The email addresses to contact the entity represented by this Card. An EmailAddress object has the following properties:¶

• @type: String. This MUST be EmailAddress, if set.¶
• address: String (mandatory). The email address. This MUST be an addr-spec value as defined in Section 3.4.1 of [RFC5322].¶
• contexts: String[Boolean] (optional). The contexts in which to use this email address. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). The preference of this email address in relation to other email addresses. Also see Section 1.5.3.¶
• label: String (optional). A custom label for the value, see Section 1.5.2.¶

"emails": {
  "e1": {
    "contexts": {
      "work": true
    },
    "address": "jqpublic@xyz.example.com"
  },
  "e2": {
    "address": "jane_doe@example.com",
    "pref": 1
  }
}

2.3.2. onlineServices

Type: Id[OnlineService] (optional).¶

The online services that are associated with the entity represented by this Card. This can be messaging services, social media profiles, and other. An OnlineService object has the following properties, of which at least the uri or user property MUST be set:¶

• @type: String. This MUST be OnlineService, if set.¶
• service: String (optional). The name of the online service or protocol. The name MAY be capitalized the same as on the service's website, app or publishing material, but names MUST be considered equal is they match case-insensitively. Examples are GitHub, kakao, Mastodon.¶
• uri: String (optional). This identifies the entity represented by this card at the online service. This MUST be a URI as defined in Section 3 of [RFC3986] and updates.¶
• user: String (optional). This names the entity represented by this Card at the online service. Any free-text value is allowed. The service property SHOULD be set.¶
• contexts: String[Boolean] (optional). The contexts in which to use this service. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). The preference of this service in relation to other services. Also see Section 1.5.3.¶
• label: String (optional). A custom label for the value, see Section 1.5.2.¶

"onlineServices": {
  "x1": {
    "uri": "xmpp:alice@example.com",
  },
  "x2": {
    "service": "Mastodon",
    "user": "@alice@example2.com",
    "uri": "https://example2.com/@alice",
  }
}

2.3.3. phones

Type: Id[Phone] (optional).¶

The phone numbers to contact the entity represented by this Card. A Phone object has the following properties:¶

• @type: String. This MUST be Phone, if set.¶
• number: String (mandatory). The phone number, as either a URI or free-text. Typical URI schemes are the [RFC3966] tel or [RFC3261] sip schemes, but any URI scheme is allowed.¶

• features: String[Boolean] (optional). The set of contact features that this phone number may be used for. The set is represented as an object, with each key being a method type. The boolean value MUST be true. The enumerated (Section 1.7.3) method type values are:¶

  • mobile The number is for a mobile phone.¶
  • voice The number is for calling by voice.¶
  • text The number supports text messages (SMS).¶
  • video The number supports video conferencing.¶
  • main-number This number is the main phone number, such as the number of the front-desk at a company, as opposed to a direct-dial number of an individual employee.¶
  • textphone The number is for a device for people with hearing or speech difficulties.¶
  • fax The number is for sending faxes.¶
  • pager The number is for a pager or beeper.¶
• contexts: String[Boolean] (optional). The contexts in which to use this number. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). The preference of this number in relation to other numbers. Also see Section 1.5.3.¶
• label: String (optional). A custom label for the value, see Section 1.5.2.¶

"phones": {
  "tel0": {
    "contexts": {
      "private": true
    },
    "features": {
      "voice": true
    },
    "number": "tel:+1-555-555-5555;ext=5555",
    "pref": 1
  },
  "tel3": {
    "contexts": {
      "work": true
    },
    "number": "tel:+1-201-555-0123",
  }
}

2.3.4. preferredLanguages

Type : String[LanguagePref[]] (optional).¶

Defines the preferred languages for contacting the entity associated with this Card. The keys in the object MUST be [RFC5646] language tags. The values are a (possibly empty) list of contact language preferences for this language. A valid LanguagePref object MUST have at least one of its properties other than the @type property set.¶

A LanguagePref object has the following properties:¶

• @type: String. This MUST be LanguagePref, if set.¶
• contexts: String[Boolean] (optional). Defines the contexts in which to use this language. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). Defines the preference of this language in relation to other languages of the same contexts. Also see Section 1.5.3.¶

"preferredLanguages": {
  "en": [
    {
      "contexts": {
        "work": true
      },
      "pref": 1
    }
  ],
  "fr": [
    {
      "contexts": {
        "work": true
      },
      "pref": 2
    },
    {
      "contexts": {
        "private": true
      }
    }
  ]
}

2.4.1. calendars

Type: Id[Calendar] (optional).¶

These are resources for calendaring, such as calendars to lookup free-busy information for the entity represented by this Card. A Calendar object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:¶

• The @type property value MUST be Calendar, if set.¶

The enumerated (Section 1.7.3) values of the kind property are:¶

• calendar The resource is a calendar that contains entries such as calendar events or tasks.¶
• freeBusy The resource allows for free-busy lookups, for example to schedule group events.¶

"calendars": {
  "calA": {
    "kind": "calendar",
    "uri": "webcal://calendar.example.com/calA.ics"
  },
  "project-a": {
    "kind": "freeBusy",
    "uri": "https://calendar.example.com/busy/project-a"
  }
}

2.4.2. schedulingAddresses

Type: Id[SchedulingAddress] (optional).¶

The scheduling addresses by which the entity may receive calendar scheduling invitations. A SchedulingAddress object has the following properties:¶

• @type: String. This MUST be SchedulingAddress, if set.¶

• uri: String (mandatory). The address to use for calendar scheduling with this contact. This MUST be a URI as defined in Section 3 of [RFC3986] and updates.¶
• contexts: String[Boolean] (optional). The contexts in which to use this scheduling address. Also see Section 1.5.1.¶
• pref: UnsignedInt (optional). The preference of this scheduling address in relation to other scheduling address. Also see Section 1.5.3.¶
• label: String (optional). A custom label for the scheduling address, see Section 1.5.2.¶

"schedulingAddresses": {
  "sched1": {
    "uri": "mailto:janedoe@example.com"
  }
}

2.5.1. addresses

Type: Id[Address] (optional).¶

A map of address identifiers to Address objects, containing physical locations. An Address object has the following properties:¶

• @type: String. This MUST be Address, if set.¶

• components: AddressComponent[] (optional). The components of this address. The concatenation of the component values SHOULD result in a valid address for the Card language. What characters to insert between address components is specific to the language. The defaultSeparator property and the separator AddressComponent kind give guidance what characters to insert, but implementations are free to choose any others.¶

• countryCode: String (optional). The Alpha-2 country code [ISO.3166-1.2006].¶
• coordinates: String (optional). A [RFC5870] "geo:" URI for the address.¶
• timeZone: String (optional). Identifies the time zone this address is located in. This MUST be a time zone name registered in the IANA Time Zone Database [IANATZ]¶

• contexts: String[Boolean] (optional). The contexts of the address information. The boolean value MUST be true. In addition to the common contexts (Section 1.5.1), allowed key values are:¶

  • billing An address to be used for billing.¶
  • delivery An address to be used for delivering physical items.¶
• full: String (optional). This is the full address, including street, region or country. The purpose of this property is to define an address, even if the individual address components are not known. If the street property is set, the full property SHOULD NOT be set.¶
• pronounce: Pronounce (optional). This defines how to pronounce this address, e.g., the full address. Also see Section 1.5.4.¶
• defaultSeparator: String (optional). The default separator to insert between address component values when concatenating all address component values to a single String. Also see the definition of the separator kind for the AddressComponent object.¶
• pref: UnsignedInt (optional). The preference of this address in relation to other addresses. Also see Section 1.5.3.¶

An AddressComponent object has the following properties:¶

• @type: String. This MUST be AddressComponent, if set.¶
• value: String (mandatory). The value of this address component.¶

• kind: String (mandatory). The kind of this address component. The enumerated (Section 1.7.3) values are:¶

  • room. The room or suite number or identifier.¶
  • apartment. The extension designation, such as apartment number or unit or box number.¶
  • floor. The floor or level this address is located on.¶
  • building. The building, tower, or condominium this address is located in.¶
  • number. The street number, e.g., "123". This value is not restricted to numeric values, and can include any value such as number ranges ("112-10"), grid style ("39.2 RD"), alphanumerics ("N6W23001") or fractionals ("123 1/2").¶
  • name. The street name.¶
  • block. The block name or number.¶
  • subdistrict. The sub district, ward or other subunit of a district.¶
  • district. The district name.¶
  • locality. The municipality, city, town, village, post-town, or another locality.¶
  • region. The administrative area, such as province, state, prefecture, county, canton.¶
  • postcode The postal code, post code, ZIP code or other short code associated with the address by the relevant country's postal system.¶
  • country The country name.¶
  • direction. The Cardinal direction or quadrant, e.g., "North".¶
  • landmark. The publicly known prominent feature that can substitute the street name and number, e.g., White House, Taj Mahal.¶
  • postOfficeBox. The post office box number or identifier.¶
  • separator. A separator for two address components. The value property of the component includes the verbatim separator, for example a newline character or even an empty string. This value has higher precedence than the defaultSeparator property of the Address.¶
• pronounce: Pronounce (optional). This defines how to pronounce this address component. Also see Section 1.5.4.¶

The following examples illustrate the use of this property.¶

"addresses": {
  "k23": {
    "contexts": {
      "work": true
    },
    "components": [
      { "kind": "number", "value": "54321" },
      { "kind": "separator", "value": " " },
      { "kind": "name", "value": "Oak St" },
      { "kind": "locality", "value": "Reston" },
      { "kind": "region", "value": "VA" },
      { "kind": "separator", "value": " " },
      { "kind": "postcode", "value": "20190" },
      { "kind": "country", "value": "USA" }
    ],
    "countryCode": "US",
    "defaultSeparator": ", "
  }
}

"addresses": {
  "k25": {
    "components": [
      { "kind": "number", "value": "46" },
      { "kind": "name", "value": "1 Sukhumvit 51 Alley" },
      { "kind": "subdistrict", "value": "Khlong Tan Nuea" },
      { "kind": "district", "value": " Watthana" },
      { "kind": "locality", "value": "Bangkok" },
      { "kind": "country", "value": "Thailand" },
      { "kind": "postcode", "value": "10110" }
    ],
    "defaultSeparator": ", "
  }
}

"addresses": {
   "k26": {
     "components": [
       { "kind": "block", "value": "2-7" },
       { "kind": "separator", "value": "-" },
       { "kind": "number", "value": "2" },
       { "kind": "separator", "value": " " },
       { "kind": "district", "value": "Marunouchi" },
       { "kind": "locality", "value": "Chiyoda-ku" },
       { "kind": "region", "value": "Tokyo" },
       { "kind": "separator", "value": " " },
       { "kind": "postcode", "value": "100-8994" }
     ],
     "defaultSeparator": ", ",
     "full": "2-7-2 Marunouchi, Chiyoda-ku, Tokyo 100-8994"
   }
},
"localizations": {
  "jp": {
    "k26": {
      "components": [
        { "kind": "region", "value": "東京都" },
        { "kind": "locality", "value": "千代田区" },
        { "kind": "district", "value": "丸ノ内" },
        { "kind": "block", "value": "2-7" },
        { "kind": "separator", "value": "-" },
        { "kind": "number", "value": "2" },
        { "kind": "postcode", "value": "〒100-8994" }
      ],
      "defaultSeparator": "",
      "full": "〒100-8994東京都千代田区丸ノ内2-7-2"
    }
  }
}

2.6.1. cryptoKeys

Type: Id[CryptoKey] (optional).¶

These are cryptographic resources such as public keys and certificates associated with the entity represented by this Card. A CryptoKey object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:¶

• The @type property value MUST be CryptoKey, if set.¶

The following example shows how refer to an external cryptographic resource.¶

"cryptoKeys": {
  "mykey1": {
    "uri": "https://www.example.com/keys/jdoe.cer"
  }
}

The following example shows how to embed key data in the CryptoKey. The key data is depicted in multiple lines only for demonstration purposes.¶

"cryptoKeys": {
  "mykey2": {
    "uri": "data:,-----BEGIN RSA PUBLIC KEY-----\n
MIIBCgKCAQEA+xGZ/wcz9ugFpP07Nspo6U17l0YhFiFpxxU4pTk3Lifz9R3zsIsu\n
ERwta7+fWIfxOo208ett/jhskiVodSEt3QBGh4XBipyWopKwZ93HHaDVZAALi/2A\n
+xTBtWdEo7XGUujKDvC2/aZKukfjpOiUI8AhLAfjmlcD/UZ1QPh0mHsglRNCmpCw\n
mwSXA9VNmhz+PiB+Dml4WWnKW/VHo2ujTXxq7+efMU4H2fny3Se3KYOsFPFGZ1TN\n
QSYlFuShWrHPtiLmUdPoP6CV2mML1tk+l7DIIqXrQhLUKDACeM5roMx0kLhUWB8P\n
+0uj1CNlNN4JRZlC7xFfqiMbFRU9Z4N6YwIDAQAB\n
-----END RSA PUBLIC KEY-----"
  }
}

2.6.2. directories

Type: Id[Directory] (optional).¶

These are directory service resources, such as entries in a directory or organizational directories for lookup. A Directory object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:¶

• The @type property value MUST be Directory, if set.¶

The enumerated (Section 1.7.3) values of the kind property are:¶

• directory The resource is a directory service where the entity represented by this Card is part of. This typically is an organizational directory that also contains associated entities, e.g., co-workers and management in a company directory.¶
• entry The resource is a directory entry of the entity represented by this Card. In contrast to the directory type, this is the specific URI for the entity within a directory.¶

In addition, the Directory object has the following property:¶

• listAs: UnsignedInt (optional). This defines the position of this directory resource in the list of all Directory objects having the same kind in this Card. If set, the listAs value MUST be higher than zero. Multiple directory resources MAY have the same listAs property value, or none. Sorting such entries is implementation-specific.¶

"directories": {
  "dir1": {
    "kind": "entry",
    "uri": "https://dir.example.com/addrbook/jdoe/Jean%20Dupont.vcf"
  },
  "dir2": {
    "kind": "directory",
    "uri": "ldap://ldap.example/o=Example%20Tech,ou=Engineering",
    "pref": 1
  }

2.6.3. links

Type: Id[Link] (optional).¶

These are links to resources that do not fit any of the other use-case specific resource properties. A Link object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:¶

• The @type property value MUST be Link, if set.¶

The enumerated (Section 1.7.3) values of the kind property are:¶

• contact The resource is a URI by which the entity represented by this Card may be contacted, including web forms or other media that require user interaction.¶

"links": {
  "link3": {
    "kind": "contact",
    "uri": "mailto:contact@example.com",
    "pref": 1
  }
}

2.6.4. media

Type: Id[Media] (optional).¶

These are media resources such as photographs, avatars, or sounds associated with the entity represented by this Card. A Media object has all properties of the Resource (Section 1.4.4) data type, with the following additional definitions:¶

• The @type property value MUST be Media, if set.¶

The enumerated (Section 1.7.3) values of the kind property are:¶

• photo The resource is a photograph or avatar.¶
• sound The resource is audio media, e.g., to specify the proper pronunciation of the name property contents.¶
• logo The resource is a graphic image or logo associated with the entity represented by this Card.¶

"media": {
  "res45": {
    "kind": "sound",
    "uri": "CID:JOHNQ.part8.19960229T080000.xyzMail@example.com"
  },
  "res47": {
    "kind": "logo",
    "uri": "https://www.example.com/pub/logos/abccorp.jpg"
  },
  "res1": {
    "kind": "photo",
    "uri": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4..."
  }
}

2.7.1. localizations

Type: String[PatchObject] (optional).¶

This localizes property values in this Card to languages other than the main language. Localizations provide language-specific alternatives for existing property values and SHOULD NOT add new properties.¶

The keys in the localizations property object are language tags [RFC5646]. The values are patch objects which localize the Card in the respective language tag. The paths in the PatchObject are relative to the Card that includes the localizations property. A patch MUST NOT target the localizations property.¶

Conceptually, a Card is localized as follows:¶

• Determine the language tag in which this Card should be localized in.¶
• If the localizations property includes a key for that language, obtain the PatchObject value. If there is no such key, stop.¶
• Create a copy of the Card, but do not copy the localizations property.¶
• Apply all patches in the PatchObject to the copy of the Card.¶
• Optionally, set the language property in the copy of the Card.¶
• Use the patched copy of the Card as the localized variant of the original Card.¶

A patch in the PatchObject may contain any value type. Its value MUST be a valid value according to the definition of the patched property.¶

Figure 37 localizes the name property by completely replacing its contents in Ukrainian language with Cyrillic script.¶

{
  "@type": "Card",
  "uid": "F918F30B-91E4-4DB8-B221-28AE7D28984D",
  "version": "1.0",
  "name": {
    "components": [
      { "kind": "title", "value": "Mr." },
      { "kind": "given", "value": "Ivan" },
      { "kind": "middle", "value": "Petrovich" },
      { "kind": "surname", "value": "Vasiliev" }
    ]
  },
  "localizations": {
    "uk-Cyrl": {
      "name": {
        "components": [
          { "kind": "title", "value": "г-н" },
          { "kind": "given", "value": "Иван" },
          { "kind": "middle", "value": "Петрович" },
          { "kind": "surname", "value": "Васильев" }
        ]
      }
    }
  }
}

Figure 38 localizes the title name by patching inside the titles property. All properties but the name property in the Title object are left as-is.¶

"name" {
  "full": "Gabriel García Márquez"
  "titles": {
    "t1": {
      "kind": "title",
      "name": "novelist"
    }
  }
},
"localizations": {
  "es": {
    "titles/t1/name": "autor"
  }
}

2.8.1. anniversaries

Type : Id[Anniversary] (optional).¶

These are memorable dates and events for the entity represented by this Card. An Anniversary object has the following properties:¶

• @type: String. This MUST be Anniversary, if set.¶

• kind: String (mandatory). Specifies the kind of the anniversary. The enumerated (Section 1.7.3) values are:¶

  • birth: a birthday anniversary¶
  • death: a deathday anniversary¶
  • wedding: a wedding day anniversary¶

• date: PartialDate|Timestamp (mandatory, defaultType: PartialDate).¶

  The date of this anniversary in the Gregorian calendar. This MUST either be a whole or partial calendar date or a complete UTC timestamp (see the definition of the Timestamp and PartialDate object types below).¶

• place: Address (optional). An address associated with this anniversary, e.g., the place of birth or death.¶

A PartialDate object represents a complete or partial calendar date in the Gregorian calendar. It represents either a complete date, or a year, or a month in a year, or a day in a month. It has the following properties, of which at least year or month and day MUST be set:¶

• @type: String. This MUST be PartialDate, if set.¶
• year: UnsignedInt (optional). This is the calendar year.¶
• month: UnsignedInt (optional). This is the calendar month, represented as the integers 1 <= month <= 12. If this property is set then either year or day MUST be set.¶
• day: UnsignedInt (optional). This is the calendar month day, represented as the integers 1 <= day <= 31, depending on the validity within the month and year. If this property is set then month MUST be set.¶
• calendarScale: String (optional). This is the calendar system in which this date occurs, in lowercase. This MUST be either a CLDR-registered calendar system name [RFC7529] or a vendor-specific value. The year, month and day still MUST be represented in the Gregorian calendar. Note that the year property might be required to convert the date between the Gregorian calendar and the respective calendar system.¶

A Timestamp object has the following properties:¶

• @type: String. This MUST be Timestamp, if set.¶
• utc: UTCDateTime (mandatory). Specifies the point in time in UTC time.¶

Figure 39 illustrates anniversaries with partial dates and timestamp. Note how the @type property is set for the Timestamp object value according to the rules defined Section 1.3.4.¶

"anniversaries": {
  "k8": {
    "kind": "birth",
    "date": {
      "year": 1953,
      "month": 4,
      "day": 15
    }
  },
  "k9": {
    "kind": "death",
    "date": {
      "@type": "Timestamp",
      "utc": "2019-10-15T23:10:00Z"
    },
    "place": {
      "full": "4445 Tree Street\nNew England, ND 58647\nUSA"
    }
  }
}

2.8.2. keywords

Type: String[Boolean] (optional). A set of free-text keywords, also known as tags. The set is represented as an object, with each key being a keyword. The boolean value MUST be true.¶

"keywords": {
  "internet": true,
  "IETF": true
}

2.8.3. notes

Type: Id[Note] (optional).¶

Free-text notes associated with this Card. A Note object has the following properties:¶

• @type: String. This MUST be Note, if set.¶

• note: String (mandatory). The free text value of this note.¶

• created: UTCDateTime (optional). The date and time when this note was created.¶

• author: Author (optional). The author of this note.¶

An Author object has the following properties, of which at least one other than @type MUST be set:¶

• @type: String. This MUST be Author, if set.¶

• name: String (optional). The name of this author.¶

• uri: String (optional). A URI value that identifies the author.¶

"notes": {
  "n1": {
    "note": "Open office hours are 1600 to 1715 EST, Mon-Fri",
    "created": "2022-11-23T15:01:32Z",
    "author": {
      "name": "John"
    }
  }
}

2.8.4. personalInfo

Type: Id[PersonalInfo] (optional).¶

Defines personal information about the entity represented by this Card. A PersonalInfo object has the following properties:¶

• @type: String. This MUST be PersonalInfo, if set.¶

• kind: String (mandatory). Specifies the kind of this personal information. The enumerated (Section 1.7.3) values are:¶

  • expertise: a field of expertise or credential¶
  • hobby: a hobby¶
  • interest: an interest¶
• value: String (mandatory). The actual information.¶

• level: String (optional). Indicates the level of expertise, or engagement in hobby or interest. The enumerated (Section 1.7.3) values are:¶

  • high¶
  • medium¶
  • low¶
• listAs: UnsignedInt (optional). This defines the position of this personal information in the list of all PersonalInfo objects having the same kind in this Card. If set, the listAs value MUST be higher than zero. Multiple personal information entries MAY have the same listAs property value, or none. Sorting such entries is implementation-specific.¶
• label: String (optional). A custom label. See Section 1.5.2.¶

"personalInfo": {
  "pi2": {
    "kind": "expertise",
    "value": "chemistry",
    "level": "high"
  },
  "pi1": {
    "kind": "hobby",
    "value": "reading",
    "level": "high"
  },
  "pi6": {
    "kind": "interest",
    "value": "r&b music",
    "level": "medium"
  }
}

4.3.1. Preliminary Community Review

Notice of a potential new registration MUST be sent to the Calext mailing list <calsify@ietf.org> for review. This mailing list is appropriate to solicit community feedback on a proposed registry assignment.¶

The intent of the public posting to this list is to solicit comments and feedback on the choice of the item name or value, the unambiguity of its description, and a review of any interoperability or security considerations. The submitter may submit a revised registration proposal or abandon the registration completely at any time.¶

4.3.2. Submit Request to IANA

Registration requests can be sent to <iana@iana.org>.¶

4.3.3. Designated Expert Review

The primary concern of the designated expert (DE) is preventing name collisions and encouraging the submitter to document security and privacy considerations. For a common-use registration, the DE is expected to confirm that suitable documentation is available to ensure interoperability. The DE should also verify that the new assignment does not conflict with work that is active or already published within the IETF.¶

The DE will either approve or deny the registration request and publish a notice of the decision to the Calext WG mailing list or its successor, as well as inform IANA. A denial notice must be justified by an explanation, and, in the cases where it is possible, concrete suggestions on how the request can be modified to become acceptable should be provided.¶

4.3.4. Change Procedures

Once a JSContact registry group item has been published by IANA, the change controller may request a change to its definition. The same procedure that would be appropriate for the original registration request is used to process a change request.¶

JSContact registrations dot not get deleted; instead, items that are no longer believed appropriate for use are declared obsolete by a change to their "intended usage" field; such items will be clearly marked in the IANA registry.¶

Significant changes to a JSContact registry item's definition should be requested only when there are serious omissions or errors in the published specification, as such changes may cause interoperability issues. When review is required, a change request may be denied if it renders entities that were valid under the previous definition invalid under the new definition.¶

4.4.1. "JSContact Version" Registry Template

Major Version:

This is the numeric value of a JSContact major version number. It MUST be a positive integer.¶

Highest Minor Version:

This is the maximum numeric value of a JSContact minor version for the given major version. It MUST be zero or a positive integer. All numbers less than or equal this value are valid minor version values for the given major version.¶

4.4.2. Initial Contents for the "JSContact Version" Registry

The following table lists the initial valid major and minor version number ranges.¶

4.5.1. "JSContact Properties" Registry Template

Property Name:

This is the name of the property. The property name MUST NOT already be registered for any of the object types listed in the "Property Context" field of this registration. Other object types MAY already have registered a different property with the same name; however, the same name MUST only be used when the semantics are analogous.¶

Property Type:

This is the type of this property, using type signatures, as specified in Section 1.3.2. The property type MUST be registered in the "JSContact Types" registry.¶

Property Context:

This is a comma-separated list of JSContact object types (Section 4.6.2) that contain this property.¶

Reference or Description:

This is a brief description or RFC number and section reference where the property is specified (omitted for "reserved" property names). This must include references to all RFC documents where this property is introduced or updated.¶

Intended Usage:

This may be "common", "reserved", or "obsolete".¶

Since Version:

This defines the JSContact version on which this property definition is based on. The version MUST be one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

Until Version:

This defines the JSContact version after which this property got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST NOT be set, or be one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

Change Controller:

This is who may request a change to this entry's definition (IETF for RFCs from the IETF stream).¶

4.5.2. Initial Contents for the "JSContact Properties" Registry

The following table lists the initial common usage entries of the "JSContact Properties" registry. The Since Version for all properties is 1.0. The Until Version for all properties is not set. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.¶

The following table lists the initial reserved usage entries of the "JSContact Properties" registry. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.¶

4.6.1. "JSContact Types" Registry Template

Type Name:

the name of the type¶

Reference or Description:

a brief description or RFC number and section reference where the Type is specified (may be omitted for "reserved" type names)¶

Intended Usage:

common, reserved, or obsolete¶

Since Version:

This defines the JSContact version on which this type definition is based on. The version MUST be one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

Until Version:

This defines the JSContact version after which this type definition got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST be not set, or one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

Change Controller:

This is who may request a change to this entry's definition (IETF for RFCs from the IETF stream).¶

4.6.2. Initial Contents for the "JSContact Types" Registry

The following table lists the initial common usage entries of the JSContact Types registry. The Since Version for all types is 1.0. The Until Version for all types is not set. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.¶

The following table lists the initial reserved usage entries of the JSContact Types registry. All types are for version 1.0. All RFC section references are for [I-D.ietf-calext-jscontact]. The change controller for all these properties is IETF.¶

4.7.1. "JSContact Enum Values" Registry Property Template

This template is for adding a subregistry for a new enumerable property to the "JSContact Enum" registry.¶

Property Name:

These are the name(s) of the property or properties where these values may be used. This MUST be registered in the "JSContact Properties" registry.¶

Context:

This is the list of allowed object types where the property or properties may appear, as registered in the "JSContact Properties" registry. This disambiguates where there may be two distinct properties with the same name in different contexts.¶

Since Version:

This defines the JSContact version on which this enum value definition is based on. The version MUST be one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

Until Version:

This defines the JSContact version after which this enum value definition got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST be not set, or one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

Change Controller:

This is who may request a change to this entry's definition (IETF for RFCs from the IETF stream).¶

Initial Contents:

This is the initial list of defined values for this enum, using the template defined in Section 4.7.2. A subregistry will be created with these values for this property name/context tuple.¶

4.7.2. "JSContact Enum Values" Registry Value Template

This template is for adding a new enum value to a subregistry in the JSContact Enum registry.¶

Enum Value:

The verbatim value of the enum¶

Reference or Description:

A brief description or RFC number and section reference for the semantics of this value¶

Since Version:

The JSContact version on which the enum value definition is based on. The version MUST be one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

Until Version:

The JSContact version after which this enum value got obsoleted and MUST NOT be used in later versions. The Until Version value either MUST be not set, or one of the allowed values of the version property in the JSContact Enum Value registry (see Table 1).¶

4.7.3. Initial Contents for the "JSContact Enum Values" Registry

For each subregistry created in this section, all RFC section references are for [I-D.ietf-calext-jscontact]. For all entries, the Since Version is 1.0, the Until Version is not set, the Change Controller is IETF.¶

Property Name:

contexts¶

Context:

Address¶

Initial Contents:

Table 6: JSContact Enum Values for contexts (Context: Address)

Enum Value	Reference or Description
billing	Section 2.5.1
delivery	Section 2.5.1
private	Section 1.5.1
work	Section 1.5.1

¶

Property Name:

contexts¶

Context:

Calendar, CryptoKey, Directory, EmailAddress, LanguagePref, Link, Media, NickName, OnlineService, Phone, Pronouns, SchedulingAddress¶

Initial Contents:

Table 7: JSContact Enum Values for contexts (Context: Calendar, CryptoKey, Directory, EmailAddress, LanguagePref, Link, Media, NickName, OnlineService, Phone, Pronouns, SchedulingAddress)

Enum Value	Reference or Description
private	Section 1.5.1
work	Section 1.5.1

¶

Property Name:

features¶

Context:

Phone¶

Initial Contents:

Table 8: JSContact Enum Values for features (Context: Phone)

Enum Value	Reference or Description
fax	Section 2.3.3
main-number	Section 2.3.3
mobile	Section 2.3.3
pager	Section 2.3.3
text	Section 2.3.3
textphone	Section 2.3.3
video	Section 2.3.3
voice	Section 2.3.3

¶

Property Name:

grammaticalGender¶

Context:

SpeakToAs¶

Initial Contents:

Table 9: JSContact Enum Values for kind (Context: SpeakToAs)

Enum Value	Reference or Description
animate	Section 2.2.4
common	Section 2.2.4
feminine	Section 2.2.4
inanimate	Section 2.2.4
masculine	Section 2.2.4
neuter	Section 2.2.4

¶

Property Name:

kind¶

Context:

AddressComponent¶

Initial Contents:

Table 10: JSContact Enum Values for kind (Context: AddressComponent)

Enum Value	Reference or Description
apartment	Section 2.5.1
block	Section 2.5.1
building	Section 2.5.1
country	Section 2.5.1
direction	Section 2.5.1
district	Section 2.5.1
floor	Section 2.5.1
landmark	Section 2.5.1
locality	Section 2.5.1
name	Section 2.5.1
number	Section 2.5.1
postcode	Section 2.5.1
postOfficeBox	Section 2.5.1
region	Section 2.5.1
room	Section 2.5.1
separator	Section 2.5.1
subdistrict	Section 2.5.1

¶

Property Name:

kind¶

Context:

Anniversary¶

Initial Contents:

Table 11: JSContact Enum Values for kind (Context: Anniversary)

Enum Value	Reference or Description
birth	Section 2.8.1
death	Section 2.8.1
wedding	Section 2.8.1

¶

Property Name:

kind¶

Context:

Calendar¶

Initial Contents:

Table 12: JSContact Enum Values for kind (Context: Calendar)

Enum Value	Reference or Description
calendar	Section 2.4.1
freeBusy	Section 2.4.1

¶

Property Name:

kind¶

Context:

Card¶

Initial Contents:

Table 13: JSContact Enum Values for kind (Context: Card)

Enum Value	Reference or Description
application	Section 2.1.4
device	Section 2.1.4
group	Section 2.1.4
individual	Section 2.1.4
location	Section 2.1.4
org	Section 2.1.4

¶

Property Name:

kind¶

Context:

Directory¶

Initial Contents:

Table 14: JSContact Enum Values for kind (Context: Directory)

Enum Value	Reference or Description
directory	Section 2.6.2
entry	Section 2.6.2

¶

Property Name:

kind¶

Context:

Link¶

Initial Contents:

Table 15: JSContact Enum Values for kind (Context: Link)

Enum Value	Reference or Description
contact	Section 2.6.3

¶

Property Name:

kind¶

Context:

Media¶

Initial Contents:

Table 16: JSContact Enum Values for kind (Context: Media)

Enum Value	Reference or Description
logo	Section 2.6.4
photo	Section 2.6.4
sound	Section 2.6.4

¶

Property Name:

kind¶

Context:

NameComponent¶

Initial Contents:

Table 17: JSContact Enum Values for kind (Context: NameComponent)

Enum Value	Reference or Description
credential	Section 2.2.1
generation	Section 2.2.1
given	Section 2.2.1
middle	Section 2.2.1
separator	Section 2.2.1
surname	Section 2.2.1
surname2	Section 2.2.1
title	Section 2.2.1

¶

Property Name:

kind¶

Context:

PersonalInfo¶

Initial Contents:

Table 18: JSContact Enum Values for kind (Context: PersonalInfo)

Enum Value	Reference or Description
expertise	Section 2.8.4
hobby	Section 2.8.4
interest	Section 2.8.4

¶

Property Name:

kind¶

Context:

Title¶

Initial Contents:

Table 19: JSContact Enum Values for kind (Context: Title)

Enum Value	Reference or Description
role	Section 2.2.5
title	Section 2.2.5

¶

Property Name:

level¶

Context:

PersonalInfo¶

Initial Contents:

Table 20: JSContact Enum Values for level (Context: PersonalInfo)

Enum Value	Reference or Description
high	Section 2.8.4
low	Section 2.8.4
medium	Section 2.8.4

¶

Property Name:

relation¶

Context:

Relation¶

Initial Contents:

Table 21: JSContact Enum Values for relation (Context: Relation)

Enum Value	Reference or Description
acquaintance	Section 2.1.8
agent	Section 2.1.8
child	Section 2.1.8
colleague	Section 2.1.8
contact	Section 2.1.8
co-resident	Section 2.1.8
co-worker	Section 2.1.8
crush	Section 2.1.8
date	Section 2.1.8
emergency	Section 2.1.8
friend	Section 2.1.8
kin	Section 2.1.8
me	Section 2.1.8
met	Section 2.1.8
muse	Section 2.1.8
neighbor	Section 2.1.8
parent	Section 2.1.8
sibling	Section 2.1.8
spouse	Section 2.1.8
sweetheart	Section 2.1.8

¶

Property Name:

system¶

Context:

Pronounce¶

Initial Contents:

Table 22: JSContact Enum Values for system (Context: Pronounce)

Enum Value	Reference or Description
ipa	Section 1.5.4
jyut	Section 1.5.4
piny	Section 1.5.4

¶