VVEREID Docs
Search docsGitHub
get started

Quickstart

Pick the product you want to integrate with VEREID first. Each path takes about ten minutes.

Last updated 2026-05-20

VEREID is three products sharing one user object and one API surface. Which one you start with depends on what you are building.

Choose your path

  • Social network — you want to build a feature that reads from or writes to a user's verified public profile (posts, follows, badges) on vereid.com. Use this if you are building a "Login with VEREID" experience that also surfaces the user's verification tier in your UI.
  • VEREID Auth — you want to outsource login, password, MFA, and SSO. Drop-in OIDC + OAuth 2.1 with the killer differentiator: the vereid_verification custom claim ships in the id_token so you know how trusted each signed-in user is.
  • VEREID ID — you want a hosted verification flow your users can complete server-side. Document scan, selfie liveness, optional sanctions screen, optional passport NFC. You receive a signed result via webhook.

What all three share

LayerWhat you get
API surfaceOne https://api.vereid.com/v1/* host. Versioned in path. RFC 9457 errors.
AuthAPI keys with vk_live_ / vk_test_ prefix, bcrypt-hashed at rest, scoped per route.
AsyncHMAC-signed webhooks (vereid-signature: v1,t=...,sig=...). 30s replay window.
StorageKMS-CMK per data class. PII vault separation. Object Lock 7y for ID images, 30d for biometric templates.
ComplianceSOC 2 in progress. GDPR DSR endpoints live. EU geo-block on /v1/verify until counsel sign-off.

API keys

Get a test key from the developer console. Use it for everything in these quickstarts — no live data is touched.

export VEREID_API_KEY=vk_test_••••••••••••

Test keys are scoped to a per-developer test tenant. They cannot bill against your Stripe subscription and they cannot trigger live verification work — every /v1/verify call against a test key returns one of a fixed set of fixture results so you can build complete UX flows offline.

SDK or HTTP?

You can call the API directly with any HTTP client. We also publish official SDKs:

Everything in the quickstarts is shown in JavaScript, Python, Go, and curl so you can copy whichever flavour you prefer.

Next steps

Once you finish the quickstart for your chosen product, the most useful next reads are:

  1. Verification tiers (T0–T6) — the honest version of "what each badge actually proves".
  2. OIDC claims — the shape of the vereid_verification claim.
  3. Webhooks — how to receive and verify outbound events.
  4. Rate limits — bucket sizes and the recommended retry strategy.