@worldcoin/idkit

React SDK for World ID built on top of @worldcoin/idkit-core.

Highlights

• Headless hooks for custom UI
• Built-in controlled widgets with shadow DOM isolation
• Separate request and session APIs
• Pure JS /signing and /hashing subpath exports for server-side use

Installation

npm install @worldcoin/idkit

Basic usage

import { useIDKitRequest, orbLegacy } from "@worldcoin/idkit";

function Example() {
  const flow = useIDKitRequest({
    app_id: "app_xxxxx",
    action: "my-action",
    rp_context,
    allow_legacy_proofs: false,
    preset: orbLegacy({ signal: "user-123" }),
  });
  const isBusy =
    flow.isAwaitingUserConnection || flow.isAwaitingUserConfirmation;

  return (
    <button onClick={flow.open} disabled={isBusy}>
      Verify
    </button>
  );
}

import type { IDKitRequestHookConfig } from "@worldcoin/idkit";

const config: IDKitRequestHookConfig = {
  app_id: "app_xxxxx",
  action: "my-action",
  rp_context,
  allow_legacy_proofs: false,
  preset: { type: "OrbLegacy" },
};

Subpath Exports

Pure JS subpath exports for server-side use (no WASM or React required):

import { signRequest } from "@worldcoin/idkit/signing";
import { hashSignal } from "@worldcoin/idkit/hashing";