Feature Overview

The Profile API allows clients to retrieve and update domain profile details. There are both public and authenticated endpoints available for domain profiles. For authenticated endpoints, the API requires request signatures generated using the domain owner's private key.

Public endpoint overview

These endpoints are available without any authentication.

• Retrieve public profile data associated with a domain
  • Domain owner controls which fields are public or private
  • Private data is always the default
• Retrieve NFTs for addresses associated with domain
  • Domain can have any number of blockchain addresses associated for resolution services
  • Resolution addresses are stored on-chain
  • Query on-chain data for NFTs
• Retrieve badges data for addresses associated with domain
• Retrieve the following status of two domains

Authenticated endpoint overview

The owner of a domain may use this API to view or edit their private profile data. When managing profile data, authentication headers must be provided using the approach described below.

How to authenticate

• Determine the message that must be signed through the message generator endpoint
  • Request GET /api/user/{domain}/signature?device=true&expiry={timestamp}
    • Replace '{domain}' with desired domain
    • Replace '{expiry}' with desired Unix epoch timestamp
  • Response contains the message that must be signed
    • Message is a unique hash value
    • Represents combination of provided request parameters
    • Includes an expiration timestamp
• User must sign the message returned by the message generator API
  • For example, the Metamask wallet could be used to sign the message
  • Generated signature is used in header of subsequent GET or POST request
• Construct a request to the desired endpoint that requires user authentication
  • Must include headers
    • x-auth-domain - Must equal the {domain} in context
    • x-auth-expiration - Must equal the {expiry} timestamp in the signed message
    • x-auth-signature - Must be set to the value of the user generated signature