Reference

Public SDK and API surface

This reference documents the current public developer-facing surface in SDK version `0.2.0-alpha.3`. Demo, admin, issuer fixture, and internal trust-plane endpoints are intentionally excluded.

Packages

@union-networks/web-login

High-level browser helpers for Sign in with U-net.

createLoginSessionpollLoginSessionrenderLoginQrPayloadisApprovedLoginResultresolveWebLoginServicecreateServiceSession

@union-networks/server

Server-side assertion verification helpers.

verifyLoginAssertionWebLoginAssertionClaimsVerifyLoginAssertionOptions

@union-networks/verification

High-level verification, check catalog, and checkout-bound verification helpers.

listVerificationChecksiterateVerificationCheckscreateVerificationSessionpollVerificationResultcreateCheckoutVerificationpollCheckoutVerificationlistMiniPrograms

@union-networks/react

React hooks and small components for U-net login, verification, and catalog loading.

useUnetLoginUnetLoginQruseUnetVerificationUnetVerificationQrUnetVerificationStatususeVerificationChecksuseMiniPrograms

@union-networks/client

Framework-neutral low-level public API client and shared utilities.

createUnetClientpollUntilparseUnetQrPayloadverificationQrPayloadUnetApiErrorUnetContractErrorUnetTimeoutError

@union-networks/contracts

Generated TypeScript types from the snapshotted U-net public OpenAPI contract.

pathscomponentsoperations

Primary flows

Sign in with U-net: Add QR-based login where your service receives only a stable service-scoped ID and a short-lived signed assertion.
Request an attestation verification: Ask the U-net app for a proof of a predicate, such as age eligibility, without receiving the underlying credential.
Checkout-bound verification: Bind a verification proof to the same holder who logged into your service, preventing a different phone from satisfying a restricted checkout.
Make your web app miniapp-ready: Use the same website in normal browsers and inside U-net as an unlisted or catalog-listed miniapp.
Scoped IDs: Understand why every service receives a different identifier and how that protects users from cross-service correlation.
Login assertions: Server-side verification details for the short-lived assertion returned by U-net login flows.

tsPublic contract package

import type { components, operations, paths } from '@union-networks/contracts';

type LoginSession = components['schemas']['WebLoginSession'];
type VerificationSession = components['schemas']['VerificationSession'];