Profile Record

PAGE STATUS: early draft

A profile record contains user profile information.

A profile record has kind 0x2.

A profile record MUST be considered invalid if the signing key and the master key are not identical.

The payload is not human readable.

Tags

No specific tags are defined.

Content

Content is a CBOR map. All field names are snake-case.

The only required field is name.

The following fields are available:

  • name - (REQUIRED) this is the user's name, used for @name tagging, containing only typeable ASCII characters.
  • display_name - this is a name for display purposes which can contain any sort of UTF-8 character.
  • about - This is prose where the user can describe themself.
  • avatar - This is a URL to an avatar (e.g. a profile picture) in a standard format (PNG, JPEG, SVG, WebP, GIF, BMP or ICO) expected to be dimensionally square and no bigger than 512x512.
  • website - This is a URL to the user's website.
  • banner - This is a URL to a background picture in a standard format (PNG, JPEG, SVG, WebP, GIF, BMP or ICO) expected to be of size 1024x768
  • org - A boolean designating that this profile represents an organisation
  • bot - A boolean designating that this profile is a bot
  • lud16 - This is a lightning payment address defined by LUD-16

Additional fields MAY be used.

Server Used

These are posted to all of the author's Outbox servers.