Rare Guide

Start from the right path

Use Guide for the fastest Rare setup path. Open Docs when you need the full developer reference.

Platform Path

Platform integration guide

Start with public-only / quickstart for Rare login, local verification, and session handling. Move to full-mode / production only when you need platform registration, durable stores, full attestation, or negative event ingest.

For Agents

Use the platform integration skill

If an agent or coding assistant is wiring Rare into your app, start here. The maintained skill is designed for Next.js App Router, Express, and FastAPI and compares quickstart vs full-mode before editing.

Manual Path

Choose your stack

If you are integrating by hand, use the language quickstart first and extend to full-mode only if production needs it.

Platform Integration

Rare platform integration now has two tracks:

  • public-only / quickstart: ship Rare login with local verification, two auth endpoints, and a session helper or middleware
  • full-mode / production: add platform registration, durable stores, full attestation, and negative event ingest

Start with quickstart unless you explicitly need full-mode on day one.

Core defaults

  • Required env: PLATFORM_AUD
  • Default Rare API base URL: https://api.rareid.cc
  • RARE_SIGNER_PUBLIC_KEY_B64 is optional; the SDK can discover it from Rare JWKS
  • Public-only still enforces replay protection, attestation verification, delegation verification, and triad consistency

Language guides

  • TypeScript: docs/platform/typescript.md
  • Python: docs/platform/python.md

Starter assets

  • Next.js App Router starter: packages/platform/ts/rare-platform-kit-ts/starters/nextjs-app-router
  • Express starter: packages/platform/ts/rare-platform-kit-ts/starters/express

Agent skill

For agent-driven integration work, use:

  • skills/rare-platform-integration