Docs · Getting started

Getting started From zero to verified identity in 5 minutes.

Part of the HelixKey documentation. Reading time: ~16 min.

← Back to docs

Install the SDK

npm install @helixkey/sdk
# or
pip install helixkey
# or
cargo add helixkey

Initialize

import { HelixKey } from '@helixkey/sdk';

const hk = new HelixKey({
  network: 'sui-mainnet',
  rpcUrl: 'https://mainnet.sui.rpcpool.com',
});

Verify an identity

const result = await hk.verifyIdentity('0x7c3aed...');
// result.verified: boolean
// result.anchoredAt: bigint (Sui checkpoint)
// result.attestation: FIDO2AttestationObject | null

Five lines. That's the whole hello-world path.

Next steps

Add HelixKey to your dApp: see Developer Hub for reference integrations. Deep on the on-chain surface: Architecture. Understand the security model: Security.

← All docs Developer Hub