Skip to content

World ID: write conceptual documentation for the Recovery Agent (account-recovery-delegation) flow #189

Description

@soamdesai-tfh

The live Indexer/Gateway OpenAPI specs expose a full account-recovery-delegation feature — POST /pending-recovery-agent, POST /recovery-agent (Indexer), POST /initiate-recovery-agent-update, POST /cancel-recovery-agent-update, POST /execute-recovery-agent-update, GET /health (Gateway) — confirmed live via curl against both specs. A companion PR wires these paths into docs.json's nav so Mintlify auto-generates the raw request/response reference pages, but that only documents the wire format, not the concept: what a Recovery Agent is, when/why an app would delegate recovery to one, the security model, and how it relates to the existing recover-account endpoint.

Needs: a conceptual overview page (likely under world-id/reference/ or world-id/concepts.mdx) explaining the Recovery Agent flow end-to-end, written with input from the protocol team since this touches account-recovery security semantics that shouldn't be guessed at from the OpenAPI schema alone.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions