What you can build
- Frictionless onboarding – gate app features behind Humanity presets such as
is_21_plus,is_human, or industry-specific attestations. - Risk + compliance tooling – subscribe to authorization and credential change feeds to keep downstream systems in sync.
- Lifecycle automation – drive OAuth 2.1 + PKCE flows, revoke tokens on entitlement changes, and poll for consent results without writing boilerplate.
Quickstart
Provision credentials, run the OAuth handshake, and verify your first preset in ~10 minutes.
@humanity-org/connect-sdk
Typed helper that wraps the generated REST client plus higher-level consent flows.
API reference
Backed by the OpenAPI in this repo with Mintlify’s playground for every endpoint.
Platform pillars
- Security first – OAuth 2.1, PKCE, encrypted at rest, and auditable decision trails.
- Deterministic contracts – DTOs live in
src/contracts, SDK + docs regenerate from the same source. - CQRS at the edge – read/write isolation keeps authorization, consent, and access domains predictable under load.
Surface map
| Domain | Highlights | Primary endpoints |
|---|---|---|
| OAuth | Standard + advanced consent, approval callbacks, revocation | /oauth/authorize, /oauth/token, /oauth/revoke |
| Presets | Single + batch verification, evidence payloads, humanity user preset | /presets/{preset_name}, /presets/batch |
| Status feeds | Incremental credential + authorization changes with pagination cursors | /credentials, /authorizations |
| Discovery & health | Well-known metadata, JWKS rotation, readiness | /.well-known/*, /health, /ready |
Every endpoint documented here is also available via the SDK’s typed client. Pick whichever interface fits your deployment strategy.
Next steps
- Follow the Quickstart to stand up a local or sandbox integration.
- Review Environments & tooling for base URLs, feature flags, and readiness probes.
- Dive into the API reference for detailed schemas, examples, and autogenerated snippets.