Skip to main content
peaqID is a W3C that identifies a machine across every chain it transacts on.

​
DID format

Every peaqID follows the format: 
did:peaq:<0x-address>
The is the machine’s on . The DID resolves to a flat key-value attribute store on the peaq DID (0x0000000000000000000000000000000000000800). Any consumer can start from the DID and traverse to the machine’s identity, financial history, and .

​
Per-machine vs per-proxy

peaqOS assigns one DID per machine and one DID per . The two serve different roles:
DID typeRegistered byAttributesPurpose
Machine DIDregisterMachine (self-managed) or registerFor (proxy delegation)machineId, nftTokenId, operator, documentation_url, data_api, data_visibilityIdentifies a single machine, links to its Machine NFT and event history
Proxy DIDregisterMachine. The proxy itself is a registered machine.machineId, machinesIdentifies an operator, lists the machine IDs of all machines it manages
A machine that self-manages has no operator attribute. A proxy operator’s machines attribute is a JSON array of (e.g., [123, 456, 789]).
DID writes always go to the caller’s DID. The DID precompile keys attributes by msg.sender. A proxy that calls registerFor the machine’s and pays the , but it cannot write attributes to the machine’s DID; the machine must sign its own writeMachineDIDAttributes call. Skipping this leaves the machine unreachable through the .

​
DID attribute table

After registration, the operator or machine must explicitly call writeMachineDIDAttributes (or writeProxyDIDAttributes) to write these attributes to the DID. Registration itself only mints the identity and creates the machine ID; the DID attribute writes are a separate .
AttributeTypeDescription
machineIduint256On-chain machine ID assigned by IdentityRegistry. Primary key for all queries.
nftTokenIduint256Token ID of the machine’s Machine NFT. This is a separate ERC-721 token space and is not equal to machineId.
operatordid:peaq:0x...Proxy operator’s DID. Absent if the machine self-manages.
documentation_urlURL stringLink to machine documentation maintained by the project.
data_apiURL stringRaw data API endpoint. The MCR API reads this when data_visibility is public.
data_visibilitypublic / private / onchainControls how the MCR API exposes raw event data. Unset or empty defaults to private.
machinesJSON array stringProxy operator DID only. List of managed machine IDs. The DID precompile stores the full JSON; the MCR API truncates to the first 100 valid IDs when reading the machines attribute.

​
Byte limits

Both SDKs enforce these constraints before any DID write reaches the chain:
ConstantValueApplies to
DID_MAX_NAME_BYTES64Attribute name
DID_MAX_VALUE_BYTES2560Attribute value
Migration. peaq chain has approximately 3.5 million existing peaqID holders. Existing holders retain their peaqIDs. A migration path to the current DID format is on the roadmap; the new format is what onboards from peaqOS today.

​
Resolving a peaqID

import "dotenv/config";
import { PeaqosClient } from "@peaqos/peaq-os-sdk";

const client = PeaqosClient.fromEnv();

// Fetch machine profile by DID
const response = await fetch(
  `${client.apiUrl}/machine/did:peaq:0xMachineAddress`
);
const machine = await response.json();

console.log(machine.peaqos.did);         // "did:peaq:0x..."
console.log(machine.peaqos.machine_id);  // 123
console.log(machine.peaqos.mcr);         // "BBB"

​
Data visibility modes

The data_visibility attribute controls how the MCR API handles raw data for this machine:
ModeMCR API behaviorRaw data location
publicFetches from data_api, includes in responseProject’s API
privateReturns the data_api URL only; consumer fetches directlyProject’s API
onchainParses JSON metadata from EventRegistry events into event_data[], capped at the first 100 events per responseOnchain (higher gas cost)
private is the default when data_visibility is unset or empty.
  • Activate function registers machines and writes DID attributes
  • GET /machine/ returns the full machine profile, including DID-sourced metadata
  • Machine NFT is linked to the peaqID via the nftTokenId attribute