Launch on 01/01/2027Licenses available from 01/01/2027
Docs / How to read these docs

How to read these docs

Ready
TL;DR

These docs are organized by what you are trying to do, not by feature list. There are four ways in — see it work, understand it, integrate it, or understand why it is built this way — and most pages open with a one-line TL;DR and a who this is for, so you can tell in a few seconds whether it is the page you want.

Who this is for: everyone, once. Skim this, take whichever door below fits your reason for being here, and you will not need to come back.

Where to start#

Pick the door that matches why you are here.

See it work
You want proof, first

Bring the whole system up on your laptop and drive a real signed approval in about five minutes. Quickstart →

Understand it
You want the shape

Two minutes on What is Ydentifi, then The ceremony for how a proof is made, and Architecture for where the pieces sit.

Integrate it
You are wiring it in

Add a second factor to an existing login with Integrate: step-up, or onboard end to end with Integrate: full. Then the API reference and an SDK.

Understand the why
You want the reasoning

The opinions behind the design, argued: On passwords, On passkeys, On devices, and Why gRPC-only.

How it is laid out#

The navigation on the left follows 8 groups, roughly from “what is this” to “every last detail”:

Orientation
You are here. What Ydentifi is, and how to move around.
Concepts
The vocabulary and the model — Glossary, Architecture, The ceremony, Factors & levels, Security model. Read once; referenced everywhere.
Get started
See it run on your own machine — Quickstart and Your first ceremony.
Guides
Task recipes: integrate, enroll, authorize, manage, run the PKI, deploy, operate, troubleshoot, and get a license. Each is one job, start to finish.
Your own mobile app
Embedding the authenticator in your app — When to embed, the Swift and Kotlin SDKs, and the device-facing gRPC underneath.
The authenticator app
For the people who use the app — adding an account, approving a request, and what to do when something goes wrong — plus Support.
Reference
The exhaustive surface — API, SDKs, CLI, Configuration, Errors, Limits, Releases. Look things up here.
Background
The essays — the reasoning you reach for when a decision surprises you.

Reading a page#

Pages are built the same way, so you can navigate one you have never seen:

  • A TL;DR at the top — the whole point in a sentence or two. If it is not what you need, you have lost ten seconds, not ten minutes.
  • A who this is for line, so you can hand a page to the right person — or rule yourself out.
  • An on this page list on the right, and cross-links throughout to the concepts a page assumes. Follow them; they go where you expect.
ⓘ The status pill under each title

Ready means the page and the thing it describes are done. At launch means the page is written and the thing it describes opens to the public at launch. Nothing is left as a stub; a page either stands behind what it says or tells you it is not there yet.

Opens on 01/01/2027

Available at launch

Until then, you can try the whole ceremony on your own phone.