Downloadable Software

SIO® Developer SDK

Build persistent object identity into your applications.

The SIO Developer SDK is downloadable software that enables developers to integrate applications with the SIO object identity platform to register, access, manage, authenticate, verify, and maintain digital identities for physical and digital objects.

Downloadable Software Development Kit

SIO® Developer SDK for JavaScript/TypeScript

Package sio-developer-sdk · Version 1.0.0

View Documentation Get API Credentials

SIO® Developer SDK — downloadable software for integrating persistent object identity into applications.

What You Can Build

Register physical and digital objects with the SIO platform
Request authoritative SIO identities
Retrieve authorized object identity information
Verify SIO identities
Manage permitted object information
Record lifecycle events
Access permitted provenance information
Integrate object identity into third-party applications

Documentation

Quick Start

import { SIOClient } from "sio-developer-sdk";

const sio = new SIOClient({
    apiKey: process.env.SIO_API_KEY
});

const object = await sio.objects.register({
    type: "physical_object",
    name: "Example Object"
});

console.log(object.sioId);

The SIO identifier returned by the SDK is issued by the authoritative SIO platform. The SDK does not independently generate authoritative SIO identifiers.

Quick Start: Install the package, initialize the client, register your first object.
Authentication: Create a revocable API credential in your SIO account and keep it server-side.
Register an Object: sio.objects.register() — the platform issues the SIO identifier.
Retrieve an SIO: sio.objects.get(sioId) returns the authorized identity record.
Verify an SIO: sio.verify(sioId) returns { sioId, valid, status }.
Update an Object: sio.objects.update(sioId, data) — the server enforces authorization.
Lifecycle Events: sio.events.add(sioId, event) and sio.events.list(sioId).
Provenance: sio.provenance.get(sioId) returns permitted provenance entries.
Relationships: sio.relationships.add() and sio.relationships.get().
Error Handling: Structured SIOError classes with stable machine-readable codes.

Full reference is included in the README inside the download, and the REST endpoints the SDK calls are documented in the SIO API™ reference.

Architecture

Third-Party Application → SIO Developer SDK → SIO API → SIO Platform / Registry

The SIO platform remains the system of record. It issues identifiers, authenticates requests, enforces permissions, and maintains authoritative records and provenance. The SDK is client software only.