idOS Issuer JavaScript SDK

Server-side SDK for issuing and managing credentials in idOS. Designed for backend services that verify user identity and issue verifiable credentials.

⚖️ Legalities

By downloading, installing, or implementing any of the idOS' SDKs, you acknowledge that you have read and understood idOS' Privacy Policy and Transparency Document.

• https://www.idos.network/legal/privacy-policy
• https://www.idos.network/legal/transparency-document

Installation

pnpm add @idos-network/issuer

Quick Start

import { idOSIssuer as idOSIssuerClass } from "@idos-network/issuer";

// Initialize with your signing and encryption keys
const idOSIssuer = await idOSIssuerClass.init({
  nodeUrl: "https://nodes.idos.network",
  signingKeyPair, // Your signing keypair
  encryptionSecretKey, // Your encryption secret key
});

// Create a user profile
await idOSIssuer.createUser(user, wallet);

// Build and issue a W3C Verifiable Credential
const credential = await idOSIssuer.buildCredential(credentialFields, credentialSubject, issuer);

// Write credential using delegated write grant
await idOSIssuer.createCredentialByDelegatedWriteGrant(credentialPayload, delegatedWriteGrant);

Documentation

For complete documentation, examples, and implementation guides:

• 📖 Issuer Guide - Comprehensive implementation guide
• 🏗️ System Overview - Understanding idOS architecture
• 🔒 Encryption - Encryption key management
• ✍️ Signatures - Signer implementation details

Key Features

• User Profile Creation - Create and manage user profiles in idOS
• Credential Issuance - Issue W3C Verifiable Credentials
• Delegated Write Grants - Write credentials on behalf of users
• Credential Management - Edit and revoke issued credentials
• Multi-Chain Support - Works with EVM, NEAR, XRPL, and Stellar wallets
• Schema Validation - Optional validation against W3C VC schemas

Support

Please follow the process outlined here: https://github.com/idos-network/.github/blob/main/profile/README.md

Developing the SDK locally

Run:

pnpm dev

This will start the compiler in watch mode that will rebuild every time any of the source files are changed.

You can also create a production build by running the following command in the root folder of the SDK package:

pnpm build