Register a domain

Registering a domain gives a real-world thing its presence on IXO: an identifier, a type, a protocol class, controllers and metadata. Domains are used to create digital twins of real-world things. This page shows the shape of a registration request, the types of domain, the properties and parameters each one needs, and how a domain becomes verified.

The page is about the domain as a whole, at the point where it is created, and it applies to any programme. For the Emerging Platform's own process (DAO stages, relayer assignment, GraphQL status checks), read Emerging Platform domain registration. To create the entity at a domain's core with an on-chain message, see Manage entities.

Note

Illustrative example. The request and the Python sample show the shape of the call. They are not a tested sequence you can run as written. For what is available on each network, see Status.

Shape of the request

curl -X POST https://api.emerging.eco/v1/domains \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "type": "Project",
    "protocol": "did:ixo:protocol/clean-cooking",
    "metadata": {
      "name": "Clean Cooking Project"
    }
  }'

from emerging import Client

client = Client('YOUR_API_KEY')
domain = client.domains.create(
    type="Project",
    protocol="did:ixo:protocol/clean-cooking",
    metadata={
        "name": "Clean Cooking Project"
    }
)

Domain types

Type	What it is
Organisations	Legal or virtual organisations, managed as DAOs
Projects	Domains of type `Project`, for clean cooking initiatives
Assets	Domains of type `Asset`, for IoT-enabled cooking devices
Protocols	Templates and rules that govern how a domain behaves

Oracles and Requests are also domain types.

Domain properties

Each domain requires:

Property	What it is
Digital identifier	A unique DID that follows the Interchain Identifier format
Entity type	Organisation, Project, Device and so on
Protocol	Defines the class of the domain and the sets of properties it inherits
Controller	The account or accounts that manage the domain's record (its DID document)
Metadata	Additional standard domain settings

Parameters

Required parameters

typestringrequired

The entity type: Organisation, Project, Device and so on

classstringrequired

DID of the protocol that defines the domain's class

metadataobject

The domain's settings

Optional parameters

validFromstring

ISO timestamp from which the domain is valid

validUntilstring

ISO timestamp at which the domain expires

Domain verification

A domain must be verified by the platform's governance system:

A compliance or programme representative submits a verification proposal with the entity package.
Eligible voters review it and vote. Quorum and thresholds depend on the deployment.
On approval, the domain's status moves to Verified, and downstream services such as reporting and issuance can be enabled.

Only verified domains can take part in platform activities such as carbon credit issuance. Confirm the authentication and endpoints for your environment in the Authentication matrix and Networks and endpoints.

To choose a starting path by what you want to do, read Choose your path.

Next steps

Emerging Platform domain registration

Governance stages, entity JSON and GraphQL examples.

Digital twins

The classes of twin, their records and their relationships.

Identity and credentials

How DIDs, claims and verifiable credentials connect.

Core concepts

The parts of a domain, including its optional governance group.