Text Records (avatar & co.)

With every name come a set of records. These records are key value pairs that can be used to store information about the profile. Think of this as a user's digital backpack. Utalized for storage of preferences, public details, and more.

Types of Records

Here are some of the most commonly used records:

Name
Usage
Reference
Example

display

Preferred capitalization

Luc.eth

avatar

Avatar or logo (see Avatars)

ipfs://dQw4w9WgXcQ

description

Description of the name

DevRel @ ENS Labs

keywords

List of comma-separated keywords

person, ens

email

Email address

mail

Physical mailing address

V3X HQ

notice

Notice regarding this name

This is a notice

location

Generic location (e.g. "Toronto, Canada")

Breda, NL

phone

Phone number as an E.164 string

+1 234 567 890

header

Image URL to be used as a header/banner

ipfs://dQw4w9WgXcQ

Other Records

Currently there are a few records that have been standardised. However you are welcome to store any key value pair you desire. We generally recommend to stick to a pattern, or prefix things with your app or protocol (eg. com.discord, or org.reddit), as such to avoid collisions.

Header/Banner Record

One of the newer standardised records is the "header" record. This header record, similar to the avatar record, accepts any IPFS, Arweave, EIP155, or regular URL to an image resource. The image is then displayed as a banner on the profile page and tends to be in a 1:3 aspect ratio.

Setting Records

When records are loaded they are loaded from the resolver responsible for the name. As resolvers are user controlled, we cannot guarantee a write function is available. This makes it a more in-depth process to update a users records.

This is protocol build by ENS domains and supported by veDelegate. Follow ENS documentation for more information.

Keep reading how to integrate with the VeChain Kit

vetDomainsProfile Card

Last updated

Was this helpful?