Developer Documentation

Build with CirculeID

Complete API documentation, SDKs, and integration guides to build digital product passports into your applications.

Quick Start

Step 1

Get API Key

Step 2

Install SDK

Install our SDK for Node.js, Python, or use REST API directly.

Step 3

Create Passport

Make your first API call to create a digital product passport.

Quick Start Example

// Install the SDK
npm install @circuleid/sdk

// Initialize the client
import { CirculeID } from '@circuleid/sdk';

const client = new CirculeID({
  apiKey: 'your_api_key_here'
});

// Create a digital product passport
const passport = await client.passports.create({
  productId: 'SKU-12345',
  name: 'Organic Cotton T-Shirt',
  data: {
    materials: ['100% Organic Cotton'],
    origin: 'Gujarat, India',
    carbonFootprint: 2.1,
    certifications: ['GOTS', 'Fair Trade']
  }
});

console.log('Passport created:', passport.id);