v1

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-107095124.5 KB

Message generator endpoints

Retrieves the message that must be signed to edit private domain profile data

Retrieve the required message that must be signed by the domain owner to update a domain profile. A POST request must include the exact JSON body that will be used to make the update. The entire contents of the JSON body are included in the message hash, to ensure the signature cannot be used in combination with unauthorized modifications to the domain profile.

post/user/{domain}/signature

Path parameters

domainstring required

The domain name to query profile data

Query parameters

expirynumber

Expiry time represented by milliseconds since epoch

Request body

displayNamestring

Name of domain owner

displayNamePublicboolean

descriptionstring

Short biography about the domain

descriptionPublicboolean

locationstring

Location

locationPublicboolean

imagePathstring

URL to the domain profile picture

imagePathPublicboolean

coverPathstring

URL to the domain banner image

coverPathPublicboolean

web2Urlstring

Website URL

publicDomainSellerEmailstring

Public domain seller email visible to anyone

web2UrlPublicboolean

showDomainSuggestionboolean

showFeaturedCommunityboolean

showFeaturedPartnerboolean

phoneNumberstring

Phone number of domain owner

phoneNumberPublicboolean

privateEmailstring

Personal email address to contact the domain owner

messagingDisabledboolean

Indicates if messaging feature should be disabled

thirdPartyMessagingEnabledboolean

Indicates if third party messaging should be enabled

thirdPartyMessagingConfigTypestring

Type of third part messaging

Example request

{
  "displayName": "John Doe",
  "description": "This is my domain",
  "location": "Metaverse",
  "imagePath": "https://ipfs.io/ipfs/path/to/pfp",
  "coverPath": "https://ipfs.io/ipfs/path/to/banner",
  "web2Url": "https://www.mywebsite.com",
  "publicDomainSellerEmail": "seller@gmail.com",
  "phoneNumber": "555-555-5555",
  "privateEmail": "me@email.com",
  "thirdPartyMessagingConfigType": "Skiff",
  "data": {
    "image": {
      "base64": "aGVsbG8gd29ybGQK",
      "type": "image/png"
    },
    "cover": {
      "base64": "aGVsbG8gd29ybGQK",
      "type": "image/png"
    }
  },
  "socialAccounts": {
    "discord": "discorduser",
    "reddit": "reddituser",
    "twitter": "twitteruser",
    "telegram": "telegramuser",
    "youtube": "youtubeuser"
  }
}

Response

Message to be signed

messagestring

The message that must be signed by the domain owner's private key to authenticate a subsequent request

Example response

{
  "headers": {
    "x-auth-domain": "mydomain.tld",
    "x-auth-expires": "Milliseconds since epoch"
  }
}