SDK Integration

The Human ID SDK allows you to embed Individual Verifications directly into your website or dApp, providing a seamless verification experience without redirecting users.

Installation


npm install @holonym-foundation/human-id-sdk

Quick Start


import { initHumanID } from '@holonym-foundation/human-id-sdk'
 
// Initialize the SDK (client-side only, requires window)
const humanID = initHumanID()
 
// Request verification
const result = await humanID.requestSBT('kyc')        // Government ID
// or: humanID.requestSBT('phone')                    // Phone
// or: humanID.requestSBT('biometrics')               // Biometrics
// or: humanID.requestSBT('clean-hands')              // Proof of Clean Hands
 
if (result?.recipient) {
  console.log('Verified! Attestation issued to:', result.recipient)
}

Integration Options

Use Case	Recommendation
Client-side dApps	SDK - embeds verification flow directly
Server-side checks	API - simple true/false queries
On-chain contracts	Attestation Protocols - query Sign Protocol directly

Documentation

For complete documentation including querying verification status, prepaid verification credits, and React examples, see the SDK repository:

View full SDK documentation on GitHub

The README is actively maintained with the latest API reference and examples.