Customize Identity

Customize identity document fields with the Python Robotics SDK. Covers verification methods, authentications, services, signatures, and defaults.

This model has been absorbed into peaqOS. See peaqID for the current identity model.

Every field of the identity document is optional. Defaults are applied to the ones you omit.

Accepted options and types:

• id: string (default did:peaq:<address>)
• controller: string (default: same as id)
• verificationMethods: array of objects { id: string, type: string, controller: string, publicKeyMultibase: string }
• authentications: array of strings (verification method references)
• services: array of objects { id: string, type: string, serviceEndpoint?: string, data?: string }
• signature: object { type: string, issuer: string, hash: string }
• name: string (the on-chain key for the document; default did:peaq:<address>, which is the only name read_identity() looks up)
• tx_options, on_status: transaction options/callback

Example (custom fields):

from peaq_robot import PeaqRobot
from peaq_robot.types import TxOptions, ConfirmationMode

sdk = PeaqRobot()

res = sdk.id.create_identity(
    name=f"did:peaq:{sdk.address}",
    id=f"did:peaq:{sdk.address}",
    controller=f"did:peaq:{sdk.address}",
    verificationMethods=[{
        "id": f"did:peaq:{sdk.address}#keys-1",
        "type": "Sr25519VerificationKey2020",
        "controller": f"did:peaq:{sdk.address}",
        "publicKeyMultibase": sdk.id.keypair.public_key.hex(),
    }],
    authentications=[f"did:peaq:{sdk.address}#keys-1"],
    services=[
        {"id": "#telemetry", "type": "RobotService", "data": "v1"}
    ],
    signature={
        "type": "Sr25519VerificationKey2020",
        "issuer": sdk.address,
        "hash": "demo",
    },
    tx_options=TxOptions(mode=ConfirmationMode.FAST),
)
print(res)

# Read back the final on-chain document (decoded if available)
doc = sdk.id.read_identity()
print(doc.get("decoded_data"))  # includes id, controller, verificationMethods, authentications, services, signature

Notes:

• Omit every field to get the minimal document.
• A service carries either serviceEndpoint or compact data for small payloads.
• For FINAL confirmation and status logs, pass tx_options and on_status.