| RFC 9553 | JSContact | February 2024 |
| Stepanek & Loffredo | Standards Track | [Page] |
This specification defines a data model and JavaScript Object Notation (JSON) representation of contact card information that can be used for data storage and exchange in address book or directory applications. It aims to be an alternative to the vCard data format and to be unambiguous, extendable, and simple to process. In contrast to the JSON-based jCard format, it is not a direct mapping from the vCard data model and expands semantics where appropriate.¶
This is an Internet Standards Track document.¶
This document is a product of the Internet Engineering Task Force (IETF). It represents the consensus of the IETF community. It has received public review and has been approved for publication by the Internet Engineering Steering Group (IESG). Further information on Internet Standards is available in Section 2 of RFC 7841.¶
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained athttps://www.rfc-editor.org/info/rfc9553.¶
Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved.¶
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
This document defines a data model for contact card data normally used in address book or directory applications and services. It aims to be an alternative to the vCard data format[RFC6350].¶
The key design considerations for this data model are as follows:¶
The representation of this data model is defined in the Internet JSON (I-JSON) format[RFC7493], which is a strict subset of the JSON data interchange format[RFC8259]. Using JSON is mostly a pragmatic choice: its widespread use makes JSContact easier to adopt, and the availability of production-ready JSON implementations eliminates a whole category of parser-related interoperability issues.¶
The vCard data format[RFC6350] is an interchange format for contacts data between address book service providers and vendors. However, this format has gone through multiple specification iterations with only a subset of its deprecatedversion 3 [RFC2426] being widely in use. Consequently, products and services use an internal contact data model that is richer than what they expose when serializing that information to vCard. In addition, service providers often use a proprietary JSON representation of contact data in their APIs.¶
JSContact provides a standard JSON-based data model and representation of contact data as an alternative to proprietary formats.¶
At the time of writing this document, several missing features in vCard were brought to the attention of the authors such as social media contacts, gender pronouns, and others. This highlights how vCard is not perceived as an evolving format and, consequently, hasn't been updated for about ten years. JSContact addresses these unmet demands and defines new vCard properties and parameters to allow interchanging them in both formats.¶
The xCard[RFC6351] and jCard[RFC7095] specifications define alternative representations for vCard data in XML and JSON formats, respectively. Both explicitly aim to not change the underlying data model. Accordingly, they are regarded as equal to vCard in the context of this document.¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14[RFC2119][RFC8174] when, and only when, they appear in all capitals, as shown here.¶
The ABNF definitions in this document use the notations of[RFC5234]. ABNF rules not defined in this document are defined in either[RFC5234] (such as the ABNF for CRLF, WSP, DQUOTE, VCHAR, ALPHA, and DIGIT) or[RFC6350].¶
This section introduces the notations and terminology used to define data types in JSContact.¶
The underlying format for JSContact is JSON, so its data types also build on JSON values. The terms "object" and "array" as well as the four primitive types ("strings", "numbers", "booleans", and "null") are to be interpreted as described inSection 1 of [RFC8259]. All JSContact dataMUST be valid according to the constraints given inI-JSON [RFC7493]. Unless otherwise noted, all member names in JSON objects and all string values are case-sensitive.Within the context of JSON objects, the term "key" is synonymous with "member name" as defined inSection 1 of [RFC8259].¶
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 that has the following:¶
@type with a string value that matches the type name of the JSContact object. In general, this property does not need to be set explicitly as outlined inSection 1.3.4.¶The following sections specify how to define JSContact object types. Sections1.7 and1.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:Here, a JSContact object type namedFoo is defined. In addition to its@type property, it has a property namedqux for which valuesMUST be valid according to the definition of theNumber type. The property has one attribute,mandatory, which specifies that the propertyMUST be present for an instance of this JSContact object to be valid. Finally, a free-text description describes the semantics and further restrictions.¶
Type signatures are given for all JSON values and JSContact definitions in this document. The following conventions are used:¶
String:Number:Boolean:A[B]:A and all values are of typeB.¶A[]:A.¶A|B:A or of typeB.¶* *:Section 1.4 defines common data types, including signed or unsigned integers and dates.¶
Object properties may also have a set of attributes defined along with the type signature. These have the following meanings:¶
mandatory:optional:default:defaultType:@type property.¶@type Property@type:The purpose of the@type property is to help implementations identify which JSContact object type a given JSON object represents. ImplementationsMUST 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 bothA andB are JSContact object types:¶
AMAY have the@type property set. If the@type property is not set, then its value is implied to beA by the property definition.¶A|B (defaultType: A)MAY have the@type property set if it is an instance ofA. ItMUST have the@type property set if it is an instance ofB. If, instead, thedefaultType attribute is not defined, then the@type propertyMUST also be set forA.¶@type property set.¶In addition to the standard JSON data types, a couple of additional data types are common to the definitions of JSContact objects and properties.¶
WhereId is given as a data type, it means aString of at least 1 and a maximum of 255 octets in size, and itMUST only contain characters from theURL and Filename Safe base64url alphabet, as defined inSection 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 keysMUST 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, twoCard (Section 2) objects might use the same Ids in their respectivephotos properties. Or within the same Card, the same Id could appear in theemails andphones properties. These situations do not imply any semantic connections among the objects.¶
WhereInt is given as a data type, it means an integer in the range -253+1 <= value <= 253-1, which is the safe range for integers stored in a floating-point double, represented as a JSONNumber.¶
WhereUnsignedInt is given as a data type, it means an integer in the range 0 <= value <= 253-1, represented as a JSONNumber.¶
A PatchObject is of typeString[*] and represents an unordered set of patches on a JSON object. Each key is a path represented in a subset of the 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:¶
addresses/1/city andaddresses.¶The value associated with each pointer determines how to apply that patch:¶
A PatchObject does not define its own@type (Section 1.3.4) property. Instead, an@type property in a patchMUST be handled as any other patched property value.¶
ImplementationsMUST reject a PatchObject in its entirety if any of its patches are invalid. ImplementationsMUST NOT apply partial patches.¶
TheResource data type defines a resource associated with the entity represented by the Card, identified by a URI[RFC3986]. Later in this document, several property definitions 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 ResourceMAY define additional properties for their value types.¶
The@type property valueMUST NOT beResource; instead, itMUST be the name of a concrete resource type (seeSection 2.6). A Resource object has the following properties.¶
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).¶String (optional).The kind of the resource. The allowed values are defined in the property definition that makes use of the Resource type. Some property definitions may change this property from being optional to mandatory.¶String (mandatory).The resource value. ThisMUST be aURI as defined inSection 3 of [RFC3986].¶String (optional).Used for URI resource values. Provides the media type[RFC2046] of the resource identified by the URI.¶String[Boolean] (optional).The contexts in which to use this resource. Also seeSection 1.5.1.¶UnsignedInt (optional). The preference of this resource in relation to other resources. Also seeSection 1.5.4.¶String (optional). A custom label for the value. Also seeSection 1.5.3.¶UTCDateTime is a string indate-time format[RFC3339], with further restrictions that any lettersMUST be in uppercase and the time offsetMUST be the characterZ. Fractional second valuesMUST NOT be included unless they are non-zero, and theyMUST 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, but2010-10-10T10:10:10.000Z is invalid; the correct encoding is2010-10-10T10:10:10Z.¶
Most of the properties in this document are specific to a single JSContact object type. Such properties are defined along with the respective object type. The properties in this section are common to multiple data types and are defined here to avoid repetition. Note that these propertiesMUST only be set for a JSContact object if they are explicitly mentioned as allowable for this object type.¶
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 thephones (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. Theenumerated (Section 1.7.4) common context values are:¶
extra is a reserved property name. ImplementationsMUST NOT set this property in a JSContact object. Any JSContact object including a property with this nameMUST be considered invalid.¶
The purpose of this reserved property name is to provide implementors with a name that is certain to never occur as a property name in a JSContact object. Implementations might want to map unknown or vendor-specific properties to a variable with this name, but this is implementation-specific.¶
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. Note that succinct labels are best for proper display on small graphical interfaces and screens.¶
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 valueMUST be in the range of 1 to 100. Lower values correspond to a higher level of preference, with 1 being most preferred. If no preference is set, then the contact informationMUST 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.¶
The phonetic property defines how to pronounce a value in the language indicated in the Cardlanguage (Section 2.1.5) property or the language tag of itslocalizations (Section 2.7.1). Exemplary uses of this property are defining how to pronounce Japanese names and romanizing Mandarin or Cantonese name and address components. The properties are defined as follows:¶
String. Contains the phonetic representation of a value. Any script language subtag in the Cardlanguage (Section 2.1.5) propertyMUST be ignored for use with thephonetic property. If this property is set, then at least one of thephoneticScript orphoneticSystem properties that relate to this valueMUST be set.¶String. The script used in the value of the relatedphonetic property. ThisMUST be a valid script subtag as defined inSection 2.2.3 of [RFC5646].¶String. The phonetic system used in the related value of thephonetic property. Theenumerated (Section 1.7.4) values are:¶
ipa: denotes theInternational Phonetic Alphabet [IPA].¶jyut: denotes the Cantonese romanization system "Jyutping".¶piny: denotes the Standard Mandarin romanization system "Hanyu Pinyin".¶The relation between thephoneticSystem,phoneticScript, andphonetic properties is type-specific. This specification defines this relation in theName (Section 2.2.1) andAddress (Section 2.5.1) object types, respectively.¶
The following example illustrates thephonetic property for aname (Section 2.2.1):¶
"name": { "components": [{ "kind": "given", "value": "John", "phonetic": "/ˈdʒɑːn/" }, { "kind": "surname", "value": "Smith", "phonetic": "/smɪθ/" }], "phoneticSystem": "ipa"}phonetic Property for the Name "John Smith" as Pronounced in the USAJSContact aims to be used for international contacts and addressbook data. Notably, text values such as names and addresses are likely to cover a wide range of languages and cultures. This section describes internationalization for free-form text values as well as Uniform Resource Identifiers (URIs).¶
Properties having free-form text valuesMAY contain any valid sequence of Unicode characters encoded as a JSON string. Such values can contain unidirectional left-to-right and right-to-left text, as well as bidirectional text using Unicode Directional Formatting Characters as described in Section 2 of[UBiDi]. Implementations setting bidirectional textMUST make sure that each property value complies with the requirements of the Unicode Bidirectional Algorithm. ImplementationsMUST NOT assume that text values of adjacent properties are processed or displayed as a combined string; for example, the values of a given name component and a surname component may or may not be rendered together.¶
Several properties require their string value to be a URI as defined in[RFC3986]. ImplementationsMUST make sure to use proper percent-encoding for URIs that cannot be represented using unreserved URI characters.Section 3.1 of [RFC3987] defines how to convert Internationalized Resource Identifiers to URIs. JSContact makes no recommendation on how to display URIs, but the WHATWG URL Living Standard (see "Internationalization and special characters" (Section 4.8.3) of[WHATWG-URL]) provides guidance for URLs found in the context of a web browser.¶
This specification distinguishes between three kinds of properties regarding validation: IANA-registered properties and unknown properties, which are defined in this section, and vendor-specific properties, which are defined inSection 1.8.1. A JSContact object is invalid if any of its properties are invalid.¶
This document defines whether each property is mandatory or optional. A mandatory propertyMUST be present for a JSContact object to be valid. An optional property does not need to be present. The values of both required and optional propertiesMUST adhere to the data type and definition of that property.¶
All property names, object type names, and enumerated values are case-sensitive, unless explicitly stated otherwise in their definitions. ImplementationsMUST handle a JSContact object as invalid if a type name, property name, or enumerated value only differs in case from one defined for any JSContact version known to that implementation. This applies regardless of what JSContact version the Card object defines in itsversion (Section 2.1.2) property.Section 1.7.3 defines how to handle unknown properties.¶
An IANA-registered property is any property that has been registered according to the IANA property registry rules as outlined inSection 3. All properties defined in this specification, including their object value types and enumerated values, are registered at IANA.¶
ImplementationsMUST validate IANA-registered properties in JSContact data, unless they are unknown to the implementation (Section 1.7.3). TheyMUST 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 Cardversion (Section 2.1.2) property.¶
IANA-registered property namesMUST NOT contain US-ASCII control characters (U+0000 to U+001F, U+007F), theCOLON (U+003A), or theQUOTATION MARK (U+0022). TheyMUST only contain US-ASCII alphanumeric characters that match the ALPHA and DIGIT rules defined inAppendix B.1 of [RFC5234] or theCOMMERCIAL AT (U+0040) character. IANA-registered property namesMUST be notated in lower camel case.¶
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. ImplementationsMUST make sure that such a name does not violate the case-sensitivity rules defined inSection 1.7.1. If the property name is valid, then implementationsMUST NOT treat such properties as invalid. Instead, theyMUST preserve them in the JSContact object.¶
Implementations that create or update JSContact dataMUST 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.¶
Several properties in this document restrict their allowed values to 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 3.7). ImplementationsMUST only set IANA-registered orvendor-specific (Section 1.8.2) values for such properties.¶
Vendors may extend properties and values for experimentation or to store contacts data that is only useful for a single service or application. Such extensions are not meant for interoperation. If, instead, interoperation is desired, vendors are strongly encouraged to define and register new properties, types, and values at IANA as defined inSection 3.Section 1.7.2 defines the naming conventions for IANA-registered elements.¶
Vendor-specific property namesMUST start with a vendor-specific prefix followed by a name, as produced by thev-extension ABNF below. The prefix and name together form the property name. The vendor-specific prefixMUST 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][RFC1035]. The prefixietf.org and its subdomain names are reserved for IETF specifications. The nameMUST NOT contain theTILDE (U+007E) andSOLIDUS (U+002F) characters, as these require special escaping when encoding a JSON Pointer[RFC6901] for that property.¶
Vendor-specific propertiesMAY be set in any JSContact object. ImplementationsMUST preserve vendor-specific properties in JSContact data, irrespective if they know their use. TheyMUST 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 rulev-extension formally defines valid vendor-specific property names. Note that the vendor prefix allows for more values than Internationalized Domain Names (IDNs)[RFC8499]; therefore, JSContact implementations can simply validate property names without implementing the full set of rules that apply to domain names.¶
v-extension = v-prefix ":" v-namev-prefix = v-label *("." v-label)v-label = alnum-int / alnum-int *(alnum-int / "-") alnum-intalnum-int = ALPHA / DIGIT / NON-ASCII ; see RFC 6350, Section 3.3v-name = 1*(WSP / "!" / %x23-2e / %x30-7d / NON-ASCII) ; any characters except CTLs, DQUOTE, SOLIDUS, and TILDEThe 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, as illustrated inFigure 3:¶
"example.com:foo": "bar","example.com:foo2": { "bar": "baz"} Some JSContact IANA-registered properties allow their values to be vendor-specific. One such example is thekind (Section 2.1.4) property, which enumerates its standard values but also allows for arbitrary vendor-specific values. Such vendor-specific valuesMUST be validv-extension values as defined inSection 1.8.1. The example inFigure 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 for other systems.¶
Every instance of a JSContactCard (Section 2) indicates which JSContact version its IANA-registered properties and values are based on. The version is indicated both in theversion (Section 2.1.2) property within the Card and in theversion (Section 3.1) parameter of the JSContact MIME content type. All IANA-registered elements indicate the version at which they were introduced or obsoleted.¶
A JSContact version consists of a numeric major and minor version, separated by theFULL STOP character (U+002E). Later versions are numerically higher than former versions, with the major version being more significant than the minor version. A version value is produced by the following ABNF:¶
jsversion = 1*DIGIT "." 1*DIGIT¶
Differing major version values indicate substantial differences in JSContact semantics and format. ImplementationsMUST be prepared for property definitions and other JSContact elements that differ in a backwards-incompatible manner.¶
Differing minor version values indicate additions that enrich JSContact data but do not introduce backwards-incompatible changes. Typically, these are new property enum values or properties with a narrow semantic scope. A new minor versionMUST NOT require implementations to change their processing of JSContact data. Changing the major version number resets the minor version number to zero.¶
This specification registers JSContact version value1.0 (Table 1).¶
This section defines the JSContact object type Card. A Card stores contact information, typically that of a person, organization, or company.¶
Its media type is defined inSection 3.1.¶
Figure 5 shows a basic Card for the person "John Doe". As the object is the topmost object in the JSON data, it has the@type property set according to the rules defined inSection 1.3.4.¶
{ "@type": "Card", "version": "1.0", "uid": "22B2C7DF-9120-4969-8460-05956FE6B065", "kind": "individual", "name": { "components": [ { "kind": "given", "value": "John" }, { "kind": "surname", "value": "Doe" } ], "isOrdered": true }}CardThis section defines properties about this instance of a Card such as its unique identifier, its creation date, and how it relates to other Cards and other metadata information.¶
Type:String (mandatory)¶
This specifies the JSContact version used to define the Card. The valueMUST be one of the IANA-registered JSContact Enum Values for theversion property. Also seeSection 1.9.2.¶
"version": "1.0"
version ExampleType:UTCDateTime (optional)¶
The date and time when the Card was created.¶
"created": "2022-09-30T14:35:10Z"
created ExampleType:String (optional; default:individual)¶
The kind of the entity the Card represents.¶
Theenumerated (Section 1.7.4) values are:¶
individual: a single person¶group: a group of people or entities¶org: an organization¶location: a named location¶device: a device such as an appliance, a computer, or a network element¶application: a software application¶"kind": "individual"
kind ExampleType: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 valuesMAY be localized in thelocalizations (Section 2.7.1) property.¶
"language": "de-AT"
language ExampleType:String[Boolean] (optional)¶
This identifies the set of Cards that are members of this group Card. Each key in the set is theuid property value of the member, and each boolean valueMUST betrue. If this property is set, then the value of thekind propertyMUST begroup.¶
The opposite is not true. A group Card will usually contain themembers property to specify the members of the group, but it is not required to. A group Card without themembers 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}members ExampleType:String (optional)¶
The identifier for the product that created the Card. If set, the valueMUST be at least one character long.¶
"prodId": "ACME Contacts App version 1.23.5"
prodId ExampleType:String[Relation] (optional)¶
This relates the object to other Cards. It is represented as a map, where each key is theuid of the related Card, and the value defines the relation. The Relation object has the following properties:¶
String. ThisMUST beRelation, if set.¶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 setMUST betrue. The relationship between the two objects is undefined if the set is empty.¶
The initial list ofenumerated (Section 1.7.4) relation types matches the IANA-registeredTYPE [IANA-vCard] parameter values of the vCard RELATED property (Section 6.6.6 of [RFC6350]):¶
"relatedTo": { "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6": { "relation": { "friend": true } }, "8cacdfb7d1ffdb59@example.com": { "relation": {} }}relatedTo ExampleType:String (mandatory)¶
An identifier that is used to associate the object as the same across different systems, address books, and views. The valueSHOULD be a URN[RFC8141], but for compatibility with[RFC6350], itMAY also be a URI[RFC3986] or free-text value. The value of the URNSHOULD be in theuuid namespace[RFC4122].As of this writing, arevision [UUID] of the Universally Unique Identifier (UUID) Standards Track document[RFC4122] is in progress and will likely introduce new UUID versions and best practices to generate global unique identifiers. ImplementorsSHOULD follow any recommendations described there. Until then, implementationsSHOULD generate identifiers using the random or pseudo-random UUID version described inSection 4.4 of [RFC4122].¶
"uid": "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6"
uid ExampleThis section defines properties that name the entity represented by the Card and its related organizations and roles, and it describes how to refer to the entity represented by the Card in spoken or written language.¶
Type:Name (optional)¶
The name of the entity represented by the 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:¶
String. ThisMUST beName, if set.¶NameComponent[] (optional). Thecomponents (Section 2.2.1.2) making up this name. This propertyMUST be set if thefull property is not set; otherwise, itSHOULD be set. The component listMUST have at least one entry having a differentkind thanseparator.¶
Name componentsSHOULD be ordered such that when their values are joined as a String, a valid full name of the entity is produced. If so, implementationsMUST set theisOrdered property value totrue.¶
If the name components are ordered, then thedefaultSeparator property and name components of kindseparator give guidance on what characters to insert between components, but implementations are free to choose any others. When lacking a separator, inserting a single Space character in between the name component values is a good choice.¶
If, instead, the name components follow no particular order, then theisOrdered property valueMUST befalse, thecomponents propertyMUST NOT contain a NameComponent of kindseparator, and thedefaultSeparator propertyMUST NOT be set.¶
Figure 15 shows an example for the name "Vincent van Gogh". Note how a single name component value may consist of multiple words.¶
"name": { "components": [ { "kind": "given", "value": "Vincent" }, { "kind": "surname", "value": "van Gogh" } ], "isOrdered": true}Figure 16 illustrates a name with a second surname such as a Spanish name. Additional examples are shown in Figures18 and38.¶
"name": { "components": [ { "kind": "given", "value": "Diego" }, { "kind": "surname", "value": "Rivera" }, { "kind": "surname2", "value": "Barrientos" } ], "isOrdered": true}Boolean (optional; default:false). Indicates if the name component sequence in thecomponents property is ordered.¶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 theseparator kind for theNameComponent (Section 2.2.1.2) object. This propertyMUST NOT be set if the NameisOrdered property value isfalse or if thecomponents property is not set.¶String (optional). The full name representation of the Name. This propertyMUST be set if thecomponents property is not set.¶
"full": "Mr. John Q. Public, Esq."
full ExampleString[String] (optional). Defines how the 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 the name component type. Absence of a key indicates that the name component typeSHOULD NOT be considered during sort. Sorting by that missing name component type, or if thesortAs property is not set, is implementation-specific. This propertyMUST NOT be set if thecomponents property is not set.¶
Each key in the mapMUST be a valid name component type value as defined for thekind property of the NameComponent object (see below). For each key in the map, thereMUST exist at least one NameComponent object that has the type in thecomponents property of the 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 the name by surname. The absence ofmiddle 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 the given name; otherwise, sorting by it would be undefined.¶
String (optional). The script used in the value of the NameComponentphonetic property. SeeSection 1.5.5 for more information andFigure 19 for an example.¶String (optional). The phonetic system used in the NameComponentphonetic property. SeeSection 1.5.5 for more information andFigure 19 for an example.¶
"name": { "components": [ { "kind": "given", "value": "Robert" }, { "kind": "given2", "value": "Pau" }, { "kind": "surname", "value": "Shou Chang" } ], "sortAs": { "surname": "Pau Shou Chang", "given": "Robert" }, "isOrdered": true}sortAs Example{ "@type": "Card", "language": "zh-Hant", "name": { "components": [ { "kind": "surname", "value": "孫" }, { "kind": "given", "value": "中山" }, { "kind": "given2", "value": "文" }, { "kind": "given2", "value": "逸仙" } ] }, "localizations": { "yue": { "name/phoneticSystem": "jyut", "name/phoneticScript": "Latn", "name/components/0/phonetic": "syun1", "name/components/1/phonetic": "zung1saan1", "name/components/2/phonetic": "man4", "name/components/3/phonetic": "jat6sin1" } }}phonetic andlocalizations ExampleA NameComponent object has the following properties:¶
String. ThisMUST beNameComponent, if set.¶String (mandatory).The value of the name component. This can be composed of one or multiple words such as "Poe" or "van Gogh".¶String (mandatory). The kind of the name component. Theenumerated (Section 1.7.4) values are:¶
title: an honorific title or prefix, e.g., "Mr", "Ms", or "Dr".¶given: a given name, also known as "first name" or "personal name".¶given2: a name that appears between the given and surname such as a middle name or patronymic name.¶surname: a surname, also known as "last name" or "family name".¶surname2: a secondary surname (used in some cultures), also known as "maternal surname".¶credential: a credential, also known as "accreditation qualifier" or "honorific suffix", e.g., "B.A.", "Esq.".¶generation: a generation marker or qualifier, e.g., "Jr." or "III".¶separator: a formatting separator between two ordered name non-separator components. Thevalue property of the component includes the verbatim separator, for example, a hyphen character or even an empty string. This value has higher precedence than thedefaultSeparator property of the Name. ImplementationsMUST NOT insert two consecutive separator components; instead, theySHOULD insert a single separator component with the combined value. This component kindMUST NOT be set if the NameisOrdered property value isfalse.¶String (optional). Defines how to pronounce the name component. If this property is set, then at least one of the Name object properties,phoneticSystem orphoneticScript,MUST be set. Also seeSection 1.5.5.¶Type:Id[Nickname] (optional)¶
The nicknames of the entity represented by the Card. A Nickname object has the following properties:¶
String. ThisMUST beNickname, if set.¶String (mandatory). The nickname.¶String[Boolean] (optional).The contexts in which to use the nickname. Also seeSection 1.5.1.¶UnsignedInt (optional). The preference of the nickname in relation to other nicknames. Also seeSection 1.5.4.¶"nicknames": { "k391": { "name": "Johnny" }}nicknames ExampleType:Id[Organization] (optional)¶
The company or organization names and units associated with the Card. An Organization object has the following properties, of which at least one of thename andunits propertiesMUST be set:¶
String. ThisMUST beOrganization, if set.¶String (optional). The name of the organization.¶OrgUnit[] (optional). A list of organizational units, ordered as descending by hierarchy (e.g., a geographic or functional division sorts before a department within that division). If set, the listMUST contain at least one entry.¶String (optional). Defines how the 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, thename property valueMAY be used for comparison.¶String[Boolean] (optional).The contexts in which association with the organization apply. For example, membership in a choir may only apply in a private context. Also seeSection 1.5.1.¶An OrgUnit object has the following properties:¶
String. ThisMUST beOrgUnit, if set.¶String (mandatory). The name of the organizational unit.¶String (optional). Defines how the 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 the organizational unit in theunits property of the Organization object. The property value defines the verbatim string value to compare. In absence of this property, thename property valueMAY be used for comparison.¶"organizations": { "o1": { "name": "ABC, Inc.", "units": [ { "name": "North American Division" }, { "name": "Marketing" } ], "sortAs": "ABC" }}organizations ExampleType:SpeakToAs (optional)¶
Provides information on how to address, speak to, or refer to the entity that is represented by the Card. A SpeakToAs object has the following properties, of which at least one of thegrammaticalGender andpronouns propertiesMUST be set:¶
String. ThisMUST beSpeakToAs, if set.¶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). Theenumerated (Section 1.7.4) values are:¶
Note that the grammatical gender does not allow inferring the gender identities or assigned sex of the contact.¶
Id[Pronouns] (optional). Defines the pronouns that the contact chooses to use for themselves.¶
A Pronouns object has the following properties:¶
String. ThisMUST bePronouns, if set.¶String (mandatory). Defines the pronouns. Any value or form is allowed. Examples in English includeshe/her andthey/them/theirs. The valueMAY be overridden in thelocalizations (Section 2.7.1) property.¶String[Boolean] (optional).The contexts in which to use the pronouns. Also seeSection 1.5.1.¶UnsignedInt (optional). The preference of the pronouns in relation to other pronouns in the same context. Also seeSection 1.5.4.¶"speakToAs": { "grammaticalGender": "neuter", "pronouns": { "k19": { "pronouns": "they/them", "pref": 2 }, "k32": { "pronouns": "xe/xir", "pref": 1 } }}speakToAs ExampleType:Id[Title] (optional)¶
The job titles or functional positions of the entity represented by the Card. A Title object has the following properties:¶
String. ThisMUST beTitle, if set.¶String (mandatory). The title or role name of the entity represented by the Card.¶String (optional; default:title). Describes the organizational or situational kind of the title. Some organizations and individuals distinguish betweentitles as organizational positions androles as more temporary assignments such as in project management.¶
Theenumerated (Section 1.7.4) values are:¶
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", "organizationId": "o2" }},"organizations": { "o2": { "name": "ABC, Inc." }}titles ExampleThis section defines how properties contact the entity represented by the Card.¶
Type:Id[EmailAddress] (optional)¶
The email addresses in which to contact the entity represented by the Card. An EmailAddress object has the following properties:¶
String. ThisMUST beEmailAddress, if set.¶String (mandatory).The email address. ThisMUST be anaddr-spec value as defined inSection 3.4.1 of [RFC5322].¶String[Boolean] (optional).The contexts in which to use this email address. Also seeSection 1.5.1.¶UnsignedInt (optional). The preference of this email address in relation to other email addresses. Also seeSection 1.5.4.¶String (optional). A custom label for the value. Also seeSection 1.5.3.¶"emails": { "e1": { "contexts": { "work": true }, "address": "jqpublic@xyz.example.com" }, "e2": { "address": "jane_doe@example.com", "pref": 1 }}emails ExampleType:Id[OnlineService] (optional)¶
The online services that are associated with the entity represented by the Card. This can be messaging services, social media profiles, and other. An OnlineService object has the following properties, of which at least theuri oruser propertyMUST be set:¶
String. ThisMUST beOnlineService, if set.¶String (optional). The name of the online service or protocol. The nameMAY be capitalized the same as on the service's website, app, or publishing material, but namesMUST be considered equal if they match case-insensitively. Examples areGitHub,kakao, andMastodon.¶String (optional).Identifies the entity represented by the Card at the online service. ThisMUST be aURI as defined inSection 3 of [RFC3986].¶String (optional). Names the entity represented by the Card at the online service. Any free-text value is allowed. Theservice propertySHOULD be set.¶String[Boolean] (optional).The contexts in which to use the service. Also seeSection 1.5.1.¶UnsignedInt (optional). The preference of the service in relation to other services. Also seeSection 1.5.4.¶String (optional). A custom label for the value. Also seeSection 1.5.3.¶"onlineServices": { "x1": { "uri": "xmpp:alice@example.com" }, "x2": { "service": "Mastodon", "user": "@alice@example2.com", "uri": "https://example2.com/@alice" }}onlineServices ExampleType:Id[Phone] (optional)¶
The phone numbers in which to contact the entity represented by the Card. A Phone object has the following properties:¶
String. ThisMUST bePhone, if set.¶String (mandatory).The phone number as either a URI or free-text. Typical URI schemes aretel[RFC3966] orsip[RFC3261], but any URI scheme is allowed.¶String[Boolean] (optional). The set of contact features that the phone number may be used for. The set is represented as an object, with each key being a method type. The boolean valueMUST betrue. Theenumerated (Section 1.7.4) method type values are:¶
mobile: the number for a mobile phone.¶voice: the number for calling by voice.¶text: the number that supports text messages (SMS).¶video: the number that supports video conferencing.¶main-number: 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 for sending faxes.¶pager: the number for a pager or beeper.¶String[Boolean] (optional).The contexts in which to use the number. Also seeSection 1.5.1.¶UnsignedInt (optional). The preference of the number in relation to other numbers. Also seeSection 1.5.4.¶String (optional). A custom label for the value. Also seeSection 1.5.3.¶"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" }}phones ExampleType :Id[LanguagePref] (optional)¶
Defines the preferred languages for contacting the entity associated with the Card.¶
A LanguagePref object has the following properties:¶
String. ThisMUST beLanguagePref, if set.¶String (mandatory). The preferred language. ThisMUST be a language tag as defined in[RFC5646].¶String[Boolean] (optional).Defines the contexts in which to use the language. Also seeSection 1.5.1.¶UnsignedInt (optional).Defines the preference of the language in relation to other languages of the same contexts. Also seeSection 1.5.4.¶"preferredLanguages": { "l1": { "language": "en", "contexts": { "work": true }, "pref": 1 }, "l2": { "language": "fr", "contexts": { "work": true }, "pref": 2 }, "l3": { "language": "fr", "contexts": { "private": true } }}preferredLanguages ExampleThis section defines properties for scheduling calendar events with the entity represented by the Card.¶
Type:Id[Calendar] (optional)¶
These are resources for calendaring such as using calendars to look up free-busy information for the entity represented by the Card. A Calendar object has all properties of theResource (Section 1.4.4) data type, with the following additional definitions:¶
@type property valueMUST beCalendar, if set.¶Thekind property is mandatory. Itsenumerated (Section 1.7.4) values are:¶
"calendars": { "calA": { "kind": "calendar", "uri": "webcal://calendar.example.com/calA.ics" }, "project-a": { "kind": "freeBusy", "uri": "https://calendar.example.com/busy/project-a" }}calendars ExampleType:Id[SchedulingAddress] (optional)¶
The scheduling addresses by which the entity may receive calendar scheduling invitations. A SchedulingAddress object has the following properties:¶
String. ThisMUST beSchedulingAddress, if set.¶String (mandatory).The address to use for calendar scheduling with the contact. ThisMUST be a URI as defined inSection 3 of [RFC3986].¶String[Boolean] (optional).The contexts in which to use the scheduling address. Also seeSection 1.5.1.¶UnsignedInt (optional). The preference of the scheduling address in relation to other scheduling addresses. Also seeSection 1.5.4.¶String (optional). A custom label for the scheduling address. Also seeSection 1.5.3.¶"schedulingAddresses": { "sched1": { "uri": "mailto:janedoe@example.com" }}schedulingAddresses ExampleThis section defines properties for postal addresses and geographical locations associated with the entity represented by the Card.¶
Type:Id[Address] (optional)¶
A map of address identifiers to Address objects, containing physical locations.¶
An Address object has the following properties:¶
String. ThisMUST beAddress, if set.¶AddressComponent[] (optional). Thecomponents (Section 2.5.1.2) that make up the address. This propertyMUST be set if thefull property is not set; otherwise, itSHOULD be set. The component listMUST have at least one entry that has akind other thanseparator.¶
Address componentsSHOULD be ordered such that when their values are joined as a String, a valid full address is produced. If so, implementationsMUST set theisOrdered property value totrue.¶
If the address components are ordered, then thedefaultSeparator property and address components of kindseparator give guidance on what characters to insert between components, but implementations are free to choose any others. When lacking a separator, inserting a single Space character in between address component values is a good choice.¶
If, instead, the address components follow no particular order, then theisOrdered property valueMUST befalse, thecomponents propertyMUST NOT contain an AddressComponent of kindseparator, and thedefaultSeparator propertyMUST NOT be set.¶
Boolean (optional; default:false). Indicates if the address component sequence in thecomponents property is ordered.¶String (optional).The Alpha-2 country code[ISO.3166-1].¶String (optional). A "geo:" URI[RFC5870] for the address.¶String (optional). Identifies the time zone the address is located in. ThisMUST be a time zone name registered in IANA'sTime Zone Database [IANA-TZ].¶String[Boolean] (optional).The contexts of the address information. The boolean valueMUST betrue. In addition to the common contexts (Section 1.5.1), allowed key values are:¶
String (optional). 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 thestreet property is set, thefull propertySHOULD NOT be set.¶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 theseparator kind for theAddressComponent (Section 2.5.1.2) object. This propertyMUST NOT be set if the AddressisOrdered property value isfalse or if thecomponents property is not set.¶UnsignedInt (optional). The preference of the address in relation to other addresses. Also seeSection 1.5.4.¶String (optional). The script used in the value of the AddressComponentphonetic property. Also seeSection 1.5.5.¶String (optional). The phonetic system used in the AddressComponentphonetic property. Also seeSection 1.5.5.¶The following example illustrates the use of theaddress property. Additional examples are shown inSection 2.5.1.3.¶
"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": ", ", "isOrdered": true }}An AddressComponent object has the following properties:¶
String. ThisMUST beAddressComponent, if set.¶String (mandatory).The value of the address component.¶String (mandatory). The kind of the address component. Theenumerated (Section 1.7.4) values are:¶
room: the room, suite number, or identifier.¶apartment: the extension designation such as the apartment number, unit, or box number.¶floor: the floor or level the address is located on.¶building: the building, tower, or condominium the 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 subdistrict, ward, or other subunit of a district.¶district: the district name.¶locality: the municipality, city, town, village, post-town, or other locality.¶region: the administrative area such as province, state, prefecture, county, or 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" or "Taj Mahal".¶postOfficeBox: the post office box number or identifier.¶separator: a formatting separator between two ordered address non-separator components. Thevalue property of the component includes the verbatim separator, for example, a hyphen character or even an empty string. This value has higher precedence than thedefaultSeparator property of the Address. ImplementationsMUST NOT insert two consecutive separator components; instead, theySHOULD insert a single separator component with the combined value. This component kindMUST NOT be set if the AddressisOrdered property value isfalse.¶String (optional). Defines how to pronounce the name component. If this property is set, then at least one of the Address objectphoneticSystem orphoneticScript propertiesMUST be set. Also seeSection 1.5.5.¶Examples of addresses are shown below; also seeFigure 30.¶
"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": ", ", "isOrdered": true }}The following example illustrates the use of an address in Tokyo and its localization (Section 2.7.1) in Japanese.¶
"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", "isOrdered": true }},"localizations": { "jp": { "addresses/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", "isOrdered": true } }}This section defines properties for digital resources associated with the entity represented by the Card.¶
Type:Id[CryptoKey] (optional)¶
These are cryptographic resources such as public keys and certificates associated with the entity represented by the Card. A CryptoKey object has all properties of theResource (Section 1.4.4) data type, with the following additional definition:¶
@type property valueMUST beCryptoKey, if set.¶The following example shows how to refer to an external cryptographic resource.¶
"cryptoKeys": { "mykey1": { "uri": "https://www.example.com/keys/jdoe.cer" }}cryptoKeys with External DataThe 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:application/pgp-keys;base64,LS0tLS1CRUdJTiBSU0EgUFVC TElDIEtFWS0tLS0tCk1JSUJDZ0tDQVFFQSt4R1ovd2N6OXVnRnBQMDdOc 3BvNlUxN2wwWWhGaUZweHhVNHBUazNMaWZ6OVIzenNJc3UKRVJ3dGE3K2 ZXSWZ4T28yMDhldHQvamhza2lWb2RTRXQzUUJHaDRYQmlweVdvcEt3Wjk zSEhhRFZaQUFMaS8yQQoreFRCdFdkRW83WEdVdWpLRHZDMi9hWkt1a2Zq cE9pVUk4QWhMQWZqbWxjRC9VWjFRUGgwbUhzZ2xSTkNtcEN3Cm13U1hBO VZObWh6K1BpQitEbWw0V1duS1cvVkhvMnVqVFh4cTcrZWZNVTRIMmZueT NTZTNLWU9zRlBGR1oxVE4KUVNZbEZ1U2hXckhQdGlMbVVkUG9QNkNWMm1 NTDF0aytsN0RJSXFYclFoTFVLREFDZU01cm9NeDBrTGhVV0I4UAorMHVq MUNObE5ONEpSWmxDN3hGZnFpTWJGUlU5WjRONll3SURBUUFCCi0tLS0tR U5EIFJTQSBQVUJMSUMgS0VZLS0tLS0K" }}cryptoKeys with Embedded DataType: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 theResource (Section 1.4.4) data type, with the following additional definitions:¶
@type property valueMUST beDirectory, if set.¶Thekind property is mandatory. Itsenumerated (Section 1.7.4) values are:¶
directory: the resource is a directory service that the entity represented by the Card is a 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 the Card. In contrast to thedirectory type, this is the specific URI for the entitywithin a directory.¶In addition, the Directory object has the following property:¶
UnsignedInt (optional). Defines the position of the directory resource in the list of all Directory objects having the samekind in the Card. If set, thelistAs valueMUST be higher than zero. Multiple directory resourcesMAY have the samelistAs 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 }directories ExampleType: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 theResource (Section 1.4.4) data type, with the following additional definitions:¶
@type property valueMUST beLink, if set.¶Thekind property is optional. Itsenumerated (Section 1.7.4) values are:¶
contact: the resource is a URI by which the entity represented by the Card may be contacted; this includes web forms or other media that require user interaction.¶"links": { "link3": { "kind": "contact", "uri": "mailto:contact@example.com", "pref": 1 }}links ExampleType:Id[Media] (optional)¶
These are media resources such as photographs, avatars, or sounds that are associated with the entity represented by the Card. A Media object has all properties of theResource (Section 1.4.4) data type, with the following additional definitions:¶
@type property valueMUST beMedia, if set.¶Thekind property is mandatory. Itsenumerated (Section 1.7.4) values are:¶
"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..." }}media ExampleThis section defines properties for localizing the content of the Card in human languages.¶
Type: String[PatchObject] (optional)¶
This localizes property values to languages (other than the main language) in the Card. Localizations provide language-specific alternatives for existing property values andSHOULD NOT add new properties.¶
The keys in the localizations property object are language tags[RFC5646]. The values are patch objects that localize the Card in the respective language tag. The paths in the PatchObject are relative to the Card that includes thelocalizations property. A patchMUST NOT target thelocalizations property.¶
Conceptually, a Card is localized as follows:¶
language property in the copy of the Card.¶A patch in the PatchObject may contain any value type. Its valueMUST be a valid value according to the definition of the patched property.¶
Figure 38 localizes thename property by completely replacing its contents in Ukrainian language with Cyrillic script.¶
{ "name": { "components": [ { "kind": "title", "value": "Mr." }, { "kind": "given", "value": "Ivan" }, { "kind": "given2", "value": "Petrovich" }, { "kind": "surname", "value": "Vasiliev" } ] }, "localizations": { "uk-Cyrl": { "name": { "components": [ { "kind": "title", "value": "г-н" }, { "kind": "given", "value": "Иван" }, { "kind": "given2", "value": "Петрович" }, { "kind": "surname", "value": "Васильев" } ] } } }}Figure 39 localizes the title name by patchinginside thetitles property. All properties, except thename 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" }}This section defines properties for which none of the previous sections are appropriate.¶
Type: Id[Anniversary] (optional)¶
These are memorable dates and events for the entity represented by the Card. An Anniversary object has the following properties:¶
String. ThisMUST beAnniversary, if set.¶String (mandatory). Specifies the kind of anniversary. Theenumerated (Section 1.7.4) values are:¶
PartialDate|Timestamp (mandatory; defaultType:PartialDate). The date of the anniversary in the Gregorian calendar. ThisMUST be either a whole or partial calendar date or a complete UTC timestamp (see the definition of the Timestamp and PartialDate object types below).¶
A PartialDate object represents a complete or partial calendar date in the Gregorian calendar. It represents a complete date, a year, a month in a year, or a day in a month. It has the following properties, of which at leastyear ormonth anddayMUST be set:¶
String. ThisMUST bePartialDate, if set.¶UnsignedInt (optional). The calendar year.¶UnsignedInt (optional). The calendar month, represented as the integers 1 <= month <= 12. If this property is set, then eitheryear ordayMUST be set.¶UnsignedInt (optional). 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 thenmonthMUST be set.¶String (optional). The calendar system in which this date occurs, in lowercase. ThisMUST be either a calendar system name registered as a Common Locale Data Repository (CLDR)[RFC7529] or a vendor-specific value. The year, month, and day stillMUST be represented in the Gregorian calendar. Note that theyear property might be required to convert the date between the Gregorian calendar and the respective calendar system.¶A Timestamp object has the following properties:¶
String. ThisMUST beTimestamp, if set.¶UTCDateTime (mandatory). Specifies the point in time in UTC time.¶Figure 40 illustrates anniversaries with partial dates and a timestamp. Note how the@type property is set for theTimestamp object value according to the rules defined inSection 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" } }}anniversaries ExampleType:String[Boolean] (optional)¶
A set of free-text keywords, also known astags. The set is represented as an object, with each key being a keyword. The boolean valueMUST betrue.¶
"keywords": { "internet": true, "IETF": true}keywords ExampleType:Id[Note] (optional)¶
Free-text notes that are associated with the Card. A Note object has the following properties:¶
String. ThisMUST beNote, if set.¶String (mandatory). The free-text value of this note.¶UTCDateTime (optional). The date and time when this note was created.¶Author (optional). The author of this note.¶An Author object has the following properties, of which at least one property other than@typeMUST be set:¶
String. ThisMUST beAuthor, if set.¶String (optional). The name of this author.¶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" } }}notes ExampleType:Id[PersonalInfo] (optional)¶
Defines personal information about the entity represented by the Card.A PersonalInfo object has the following properties:¶
String. ThisMUST bePersonalInfo, if set.¶String (mandatory). Specifies the kind of personal information. Theenumerated (Section 1.7.4) values are:¶
String (mandatory).The actual information.¶String (optional). Indicates the level of expertise or engagement in hobby or interest. Theenumerated (Section 1.7.4) values are:¶
UnsignedInt (optional). Defines the position of the personal information in the list of all PersonalInfo objects that have the samekind in the Card. If set, thelistAs valueMUST be higher than zero. Multiple personal information entriesMAY have the samelistAs property value, or none. Sorting such entries is implementation-specific.¶String (optional). A custom label. SeeSection 1.5.3.¶"personalInfo": { "pi2": { "kind": "expertise", "value": "chemistry", "level": "high" }, "pi1": { "kind": "hobby", "value": "reading", "level": "high" }, "pi6": { "kind": "interest", "value": "r&b music", "level": "medium" }}personalInfo ExampleThis document defines a media type for use with JSContact data formatted in JSON.¶
None¶
version (Table 2) properties in the body partMUST match the parameter value.¶IANA has created the "JSContact" registry group. The new registry definitions in the following sections all belong to that group.¶
Registry assignments that introducebackwards-incompatible (Section 1.9) changes require the JSContact major version to change; other changes only require a change to the minor version. The registry policy for assignments that require the JSContact major version to change is Standards Action ([RFC8126],Section 4.9). The registry policy for other assignments is Specification Required ([RFC8126],Section 4.6).¶
The designated expert (DE) decides if a major or minor version change is required and assigns the new version to the"JSContact Version" registry (Section 3.4). Version numbers increment by one, and a major version change resets the minor version to zero. An assignment may apply multiple changes and to more than one registry at once, in which case a single version change is sufficient. If the registry policy is Specification Required, then the DE may decide that it is enough to document the new assignment in the Description item of the respective registry.¶
A registrationMUST have an intended usage ofcommon,reserved, orobsolete.¶
common usage denotes an item with shared semantics and syntax across systems. Up-to-date systemsMUST expect such items to occur in JSContact data.¶reserved usage reserves an item in the registry without assigning semantics to avoid name collisions with future extensions or protocol use.¶obsolete usage denotes an item that is no longer expected to be added by up-to-date systems. A new assignment has probably been defined, covering the obsolete item's semantics.¶The registration procedure is not a formal standards process but rather an administrative procedure intended to allow community comments and to check whether it is coherent without excessive time delay. It is designed to encourage vendors to document and register new items they add for use cases not covered by the original specification, leading to increased interoperability.¶
Notice of a potential new registrationMUST be sent to the Calext WG mailing list <calsify@ietf.org> for review. This mailing list is appropriate for soliciting 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.¶
Registration requests can be sent to IANA <iana@iana.org>.¶
The primary concern of the DE is preventing name collisions and encouraging the submitter to document security and privacy considerations.¶
A new type name, property name, or enumerated valueMUST NOT differ only in case from an already-registered name or value.¶
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.¶
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 do 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.¶
IANA has created the "JSContact Version" registry. The purpose of this new registry is to define the allowed value range of JSContact major and minor version numbers.¶
The registry entries sort numerically in ascending order by the "Major Version" column.¶
The registry process is outlined inSection 3.3.¶
The following table lists the initial valid major and minor version number ranges.¶
| Major Version | Highest Minor Version | Reference |
|---|---|---|
| 1 | 0 | RFC 9553 |
IANA has created the "JSContact Properties" registry. The purpose of this new registry is to allow interoperability of extensions to JSContact objects.¶
The registry entries sort alphabetically in ascending order by the following columns: "Property Name" first, "Property Context" second, and "Since Version" third. Equal entries sort in any order.¶
The registry process for a new property is outlined inSection 3.3.¶
version property in the "JSContact Enum Values" registry (seeTable 1).¶version property in the "JSContact Enum Values" registry (seeTable 1).¶IETF for RFCs from the IETF stream).¶The following table lists the initialcommon usage entries of the "JSContact Properties" registry. For all properties, the Since Version is1.0, the Until Version is not set, the change controller isIETF, and RFC section references are for RFC 9553.¶
| Property Name | Property Type | Property Context | Ref |
|---|---|---|---|
| @type | String | Address, AddressComponent, Anniversary, Author, Card, Calendar, CryptoKey, Directory, EmailAddress, LanguagePref, Link, Media, Name, NameComponent, Nickname, Note, OnlineService, Organization, OrgUnit, PartialDate, PersonalInfo, Phone, Pronouns, Relation, SchedulingAddress, SpeakToAs, Timestamp, Title | Sections2.5.1,2.8.1,2.1.1,2.4.1,2.6.1,2.6.2,2.3.1,2.3.4,2.6.3,2.6.4,2.2.1,2.2.1.3,2.8.3,2.3.2,2.2.2,2.8.4,2.3.3,2.2.3,2.1.8,2.4.2,2.2.4 |
| version | String | Card | Section 2.1.2 |
| address | String | EmailAddress | Section 2.3.1 |
| addresses | Id[Address] | Card | Section 2.5.1 |
| anniversaries | Id[Anniversary] | Card | Section 2.8.1 |
| author | Author | Note | Section 2.8.3 |
| calendars | Id[Calendar] | Card | Section 2.4.1 |
| calendarScale | String | PartialDate | Section 2.8.1 |
| components | AddressComponent[] | Address | Section 2.5.1 |
| components | NameComponent[] | Name | Section 2.2.1 |
| contexts | String[Boolean] | Address, Calendar, CryptoKey, Directory, EmailAddress, LanguagePref, Link, Media, Nickname, OnlineService, Organization, Phone, Pronouns, SchedulingAddress | Sections1.4.41.5.1,2.5.1,2.4.1,2.6.1,2.6.2,2.3.1,2.3.4,2.6.3,2.6.4,2.2.1.3,2.3.2,2.2.2,2.3.3,2.2.3,2.4.2 |
| coordinates | String | Address | Section 2.5.1 |
| countryCode | String | Address | Section 2.5.1 |
| created | UTCDateTime | Card, Note | Sections2.1.3,2.8.3 |
| date | PartialDate|Timestamp | Anniversary | Section 2.8.1 |
| day | UnsignedInt | PartialDate | Section 2.8.1 |
| defaultSeparator | String | Address, Name | Sections2.5.1,2.2.1 |
| directories | Id[Directory] | Card | Section 2.6.2 |
| emails | Id[EmailAddress] | Card | Section 2.3.1 |
| features | String[Boolean] | Phone | Section 2.3.3 |
| full | String | Address, Name | Sections2.5.1,2.2.1 |
| grammaticalGender | String | SpeakToAs | Section 2.2.3 |
| isOrdered | Boolean | Address, Name | Sections2.5.1,2.2.1 |
| keywords | String[Boolean] | Card | Section 2.8.2 |
| kind | String | AddressComponent, Anniversary, Calendar, Card, CryptoKey, Directory, Link, Media, NameComponent, PersonalInfo, Title | Sections2.5.1,2.8.1,2.4.1,2.1.4,2.6.1,2.6.2,2.6.3,2.6.4,2.2.1,2.8.4,2.2.4 |
| label | String | Calendar, CryptoKey, Directory, EmailAddress, Link, Media, OnlineService, PersonalInfo, Phone, SchedulingAddress | Sections1.5.3,2.4.1,2.6.1,2.6.2,2.3.1,2.6.3,2.6.4,2.3.2,2.8.4,2.3.3,2.4.2,1.4.4 |
| language | String | Card, LanguagePref | Sections2.1.5,2.3.4 |
| level | String | PersonalInfo | Section 2.8.4 |
| links | Id[Link] | Card | Section 2.6.3 |
| listAs | UnsignedInt | Directory, PersonalInfo | Sections2.6.2,2.8.4 |
| localizations | String[PatchObject] | Card | Section 2.7.1 |
| media | Id[Media] | Card | Section 2.6.4 |
| mediaType | String | Calendar, CryptoKey, Directory, Link, Media | Sections1.4.4,2.4.1,2.6.1,2.6.2,2.6.3,2.6.4 |
| members | String[Boolean] | Card | Section 2.1.6 |
| month | UnsignedInt | PartialDate | Section 2.8.1 |
| name | Name | Card | Section 2.2.1 |
| name | String | Author, Nickname, Organization, OrgUnit, Title | Sections2.8.3,2.2.1.3,2.2.2,2.2.4 |
| nicknames | Id[Nickname] | Card | Section 2.2.1.3 |
| note | String | Note | Section 2.8.3 |
| notes | Id[Note] | Card | Section 2.8.3 |
| number | String | Phone | Section 2.3.3 |
| onlineServices | Id[OnlineService] | Card | Section 2.3.2 |
| organizationId | String | Title | Section 2.2.4 |
| organizations | Id[Organization] | Card | Section 2.2.2 |
| personalInfo | Id[PersonalInfo] | Card | Section 2.8.4 |
| phones | Id[Phone] | Card | Section 2.3.3 |
| phonetic | String | AddressComponent, NameComponent | Sections2.5.1.2,2.2.1.2 |
| phoneticScript | String | Address, Name | Sections2.2.1,2.5.1 |
| phoneticSystem | String | Address, Name | Sections2.2.1,2.5.1 |
| place | Address | Anniversary | Section 2.8.1 |
| pref | UnsignedInt | Address, Calendar, CryptoKey, Directory, EmailAddress, LanguagePref, Link, Media, Nickname, OnlineService, Phone, Pronouns, SchedulingAddress | Sections1.4.41.5.4,2.5.1,2.4.1,2.6.1,2.6.2,2.3.1,2.3.4,2.6.3,2.6.4,2.2.1.3,2.3.2,2.3.3,2.2.3,2.4.2 |
| preferredLanguages | String[LanguagePref] | Card | Section 2.3.4 |
| prodId | String | Card | Section 2.1.7 |
| pronouns | Id[Pronouns] | SpeakToAs | Section 2.2.3 |
| relatedTo | String[Relation] | Card | Section 2.1.8 |
| relation | String[Boolean] | Relation | Section 2.1.8 |
| schedulingAddresses | Id[SchedulingAddress] | Card | Section 2.4.2 |
| service | String | OnlineService | Section 2.3.2 |
| sortAs | String[String] | Name | Section 2.2.1 |
| sortAs | String | Organization, OrgUnit | Section 2.2.2 |
| speakToAs | SpeakToAs | Card | Section 2.2.3 |
| timeZone | String | Address | Section 2.5.1 |
| titles | Id[Title] | Card | Section 2.2.4 |
| uid | String | Card | Section 2.1.9 |
| units | OrgUnit[] | Organization | Section 2.2.2 |
| updated | UTCDateTime | Card | Section 2.1.10 |
| uri | String | Author, Calendar, CryptoKey, Directory, Link, Media, OnlineService, SchedulingAddress | Sections1.4.4,2.8.3,2.4.1,2.6.1,2.6.2,2.6.3,2.6.4,2.3.2,2.4.2 |
| user | String | OnlineService | Section 2.3.2 |
| utc | UTCDateTime | Timestamp | Section 2.8.1 |
| value | String | AddressComponent, NameComponent, PersonalInfo | Sections2.5.1,2.2.1,2.8.4 |
| year | UnsignedInt | PartialDate | Section 2.8.1 |
The following table lists the initialreserved usage entries of the "JSContact Properties" registry. For this property, the change controller isIETF, and the RFC section reference is for RFC 9553.¶
| Property Name | Property Type | Property Context | Reference/Description | Intended Usage |
|---|---|---|---|---|
| extra | not applicable | not applicable | Section 1.5.2 | reserved |
IANA has created the "JSContact Types" registry. The purpose of this new registry is to avoid name collisions for JSContact type names and provide a complete reference for all data types used for JSContact property values.¶
The registry entries sort alphabetically in ascending order by the "Type Name" column. Equal entries sort in any order.¶
The registry process for a new type is outlined inSection 3.3.¶
version property in the "JSContact Enum Values" registry (seeTable 1).¶version property in the "JSContact Enum Values" registry (seeTable 1).¶IETF for RFCs from the IETF stream).¶The following table lists the initialcommon usage entries in the "JSContact Types" registry. For all of these types, the Since Version is1.0, the Until Version is not set, the change controller isIETF, and RFC section references are for RFC 9553.¶
| Type Name | Reference or Description |
|---|---|
| Address | Section 2.5.1 |
| AddressComponent | Section 2.5.1 |
| Anniversary | Section 2.8.1 |
| Author | Section 2.8.3 |
| Boolean | Section 1.3.2 |
| Calendar | Section 2.4.1 |
| Card | Section 2 |
| CryptoKey | Section 2.6.1 |
| Directory | Section 2.6.2 |
| EmailAddress | Section 2.3.1 |
| Id | Section 1.4.1 |
| Int | Section 1.4.2 |
| LanguagePref | Section 2.3.4 |
| Link | Section 2.6.3 |
| Media | Section 2.6.4 |
| Name | Section 2.2.1 |
| NameComponent | Section 2.2.1 |
| Nickname | Section 2.2.1.3 |
| Note | Section 2.8.3 |
| Number | Section 1.3.2 |
| OnlineService | Section 2.3.2 |
| Organization | Section 2.2.2 |
| OrgUnit | Section 2.2.2 |
| PartialDate | Section 2.8.1 |
| PatchObject | Section 1.4.3 |
| PersonalInfo | Section 2.8.4 |
| Phone | Section 2.3.3 |
| Pronouns | Section 2.2.3 |
| Relation | Section 2.1.8 |
| SchedulingAddress | Section 2.4.2 |
| SpeakToAs | Section 2.2.3 |
| String | Section 1.3.2 |
| Timestamp | Section 2.8.1 |
| Title | Section 2.2.4 |
| UnsignedInt | Section 1.4.2 |
| UTCDateTime | Section 1.4.5 |
The following table lists the initialreserved usage entry of the "JSContact Types" registry. For this type, the version is1.0, the change controller isIETF, and the RFC section reference is for RFC 9553.¶
| Type Name | Reference or Description |
|---|---|
| Resource | Section 1.4.4 |
IANA has created the "JSContact Enum Values" registry. The purpose of the new registry is to allow interoperable extension of semantics for JSContact properties with enumerable values. Each such property will have a subregistry of allowed values.¶
The registry entries sort alphabetically in ascending order by the following columns: "Property Name" first, "Property Context" second, and "Since Version" third. The enum values sort alphabetically in ascending order. Equal entries sort in any order.¶
The registry process for a new enum value or adding a new enumerable property is outlined inSection 3.3.¶
This template is for adding a subregistry for a new enumerable property to the "JSContact Enum" registry.¶
version property in the "JSContact Enum Values" registry (seeTable 1).¶version property in the "JSContact Enum Values" registry (seeTable 1).¶IETF for RFCs from the IETF stream).¶This template is for adding a new enum value to a subregistry in the "JSContact Enum Values" registry.¶
version property in the "JSContact Enum Values" registry (seeTable 1).¶version property in the "JSContact Enum Values" registry (seeTable 1).¶For all entries in each subregistry created in this section, the Since Version is1.0, the Until Version is not set, the Change Controller isIETF, and RFC section references are for RFC 9553.¶
| 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 |
| 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 |
| Enum Value | Reference or Description |
|---|---|
| animate | Section 2.2.3 |
| common | Section 2.2.3 |
| feminine | Section 2.2.3 |
| inanimate | Section 2.2.3 |
| masculine | Section 2.2.3 |
| neuter | Section 2.2.3 |
| 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 |
| Enum Value | Reference or Description |
|---|---|
| birth | Section 2.8.1 |
| death | Section 2.8.1 |
| wedding | Section 2.8.1 |
| Enum Value | Reference or Description |
|---|---|
| calendar | Section 2.4.1 |
| freeBusy | Section 2.4.1 |
| 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 |
| Enum Value | Reference or Description |
|---|---|
| directory | Section 2.6.2 |
| entry | Section 2.6.2 |
| Enum Value | Reference or Description |
|---|---|
| contact | Section 2.6.3 |
| Enum Value | Reference or Description |
|---|---|
| logo | Section 2.6.4 |
| photo | Section 2.6.4 |
| sound | Section 2.6.4 |
| Enum Value | Reference or Description |
|---|---|
| credential | Section 2.2.1 |
| generation | Section 2.2.1 |
| given | Section 2.2.1 |
| given2 | Section 2.2.1 |
| separator | Section 2.2.1 |
| surname | Section 2.2.1 |
| surname2 | Section 2.2.1 |
| title | Section 2.2.1 |
| Enum Value | Reference or Description |
|---|---|
| expertise | Section 2.8.4 |
| hobby | Section 2.8.4 |
| interest | Section 2.8.4 |
| Enum Value | Reference or Description |
|---|---|
| role | Section 2.2.4 |
| title | Section 2.2.4 |
| Enum Value | Reference or Description |
|---|---|
| high | Section 2.8.4 |
| low | Section 2.8.4 |
| medium | Section 2.8.4 |
| 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 |
| Enum Value | Reference or Description |
|---|---|
| ipa | Section 1.5.5 |
| jyut | Section 1.5.5 |
| piny | Section 1.5.5 |
Contact information is very privacy sensitive. It can reveal the identity, location, and credentials information, employment status, interests and hobbies, and social network of a user. Its transmission and storage must be done carefully to protect it from possible threats such as eavesdropping, replay, message insertion, deletion, modification, and on-path attacks.¶
The data being stored and transmitted may be used in systems with real-world consequences. For example, a malicious actor might provide JSContact data that uses the name of another person but insert their contact details to impersonate the unknown victim. Such systems must be careful to authenticate all data they receive to prevent them from being subverted and ensure the change comes from an authorized entity.¶
This document only defines the data format; such considerations are primarily the concern of the API or method of storage and transmission of such files.¶
The security considerations of[RFC8259] apply to the use of JSON as the data interchange format.¶
As for any serialization format, parsers need to thoroughly check the syntax of the supplied data. JSON uses opening and closing brackets for several types and structures, and it is possible that the end of the supplied data will be reached when scanning for a matching closing bracket; this is an error condition, and implementations need to stop scanning at the end of the supplied data.¶
JSON also uses a string encoding with some escape sequences to encode special characters within a string. Care is needed when processing these escape sequences to ensure that they are fully formed before the special processing is triggered, with special care taken when the escape sequences appear adjacent to other (non-escaped) special characters or adjacent to the end of data (as in the previous paragraph).¶
If parsing JSON into a non-textual structured data format, implementations may need to allocate storage to hold JSON string elements. Since JSON does not use explicit string lengths, the risk of denial of service due to resource exhaustion is small, but implementations may still wish to place limits on the size of allocations they are willing to make in any given context, to avoid untrusted data causing excessive memory allocation.¶
Several JSContact properties contain URIs as values, and processing these properties requires extra care.Section 7 of [RFC3986] discusses security risks related to URIs.¶
Fetching remote resources carries inherent risks. Connections must only be allowed on well-known ports, using allowed protocols (generally, just HTTP/HTTPS on their default ports). The URL must be resolved externally and not allowed to access internal resources. Connecting to an external source reveals IP (and therefore often location) information.¶
A maliciously constructed JSContact object may contain a very large number of URIs. In the case of published address books with a large number of subscribers, such objects could be widely distributed. Implementations should be careful to limit the automatic fetching of linked resources to reduce the risk of this being an amplification vector for a denial-of-service attack.¶