◎ Discry Score
sheerid.com
auth · API
B
0 / 100
DISCOVERY0
COMPREHENSION0
Category leader: 93 (A)
Discry your API →
AUTH · RANK #12 OF 16

SheerID is Good to agents.

Discry independently scored how well an AI agent can discover and understand the SheerID API from what’s public — not whether it’s usable. Below: every signal we checked, what’s costing the score, and what to change.

Discry your API — freeView the docs ↗

SCORED UNDER RUBRIC 1.2 · A full re-launch under Discry Score 2.5 — a new behavioral instrument, not comparable to these scores — is in progress.

Discovery

45% of score · 71/100
OpenAPI specA machine-readable OpenAPI/Swagger spec agents can parse.Pass
llms.txtAn llms.txt index that points agents to the docs that matter.Pass
llms.txt qualityThe llms.txt is focused, current, and well under the size budget.Pass
llms-full.txtA full-text bundle agents can load in one request.Fail
AGENTS.mdAn AGENTS.md that tells coding agents how to build on the API.Fail
.well-known/mcp.jsonA discoverable MCP manifest at a well-known path.Fail
MCP registryThe API is listed in a public MCP registry.Fail
robots.txt AI directivesrobots.txt allows (or explicitly guides) AI crawlers.Pass
SitemapA sitemap so agents can enumerate the docs surface.Pass

Comprehension

55% of score · 93/100
Task-oriented descriptionsEndpoints described by what they accomplish, not just their shape.Pass
Realistic examplesRunnable, real-world request/response examples.Partial
Multi-step workflowsDocs that chain calls into complete jobs an agent can follow.Pass
Error-recovery guidanceDocumented failure modes and how to recover from them.Pass
Answer-first formatThe answer leads; preamble does not bury it.Pass
Capability boundariesClear limits — what the API can and cannot do.Pass
Naming consistencyConsistent, predictable naming across endpoints.Pass
Heading hierarchyClean heading structure agents can navigate.Pass
Markdown docsDocs available as clean markdown, not JS-rendered HTML only.Pass
Token efficiencyDocs are concise enough to fit an agent context window.Pass

What we found

  • An agent landing on developer.sheerid.com gets a purpose-built map: the llms.txt explicitly addresses 'AI agents and LLMs', describes every section, and links the machine-readable OpenAPI spec — one of the strongest llms.txt files in the corpus.
  • Error documentation is exceptional for self-correction: every common errorId has a recoverable/non-recoverable flag and a 'what to do' column, and the docs explicitly disambiguate the overloaded 429 status (only apiRateLimitExceeded is retryable) — an agent would avoid retry loops that most APIs' docs would cause.
  • The REST API quickstart walks the full multi-step verification flow end-to-end (start → submit → success/docUpload/pending) with realistic request/response pairs, timeout guidance, and idempotency notes, so an agent can chain the whole workflow from one page.
  • A public OpenAPI 3.0 spec (services.sheerid.com/rest/v2/swagger.yaml) is linked directly from llms.txt, plus a dedicated guide for generating typed clients from it.
  • Agent-ecosystem discovery signals stop at the docs site: no MCP server or registry listing, no .well-known/mcp.json, no AGENTS.md in the SheerID GitHub org, and no llms-full.txt — an agent searching the MCP ecosystem would not find SheerID at all.

What to change

Prioritized by impact on discoverability. You (or your docs platform) deploy these — Discry never touches your API.

  1. 01Ship an official MCP server for verification operations and list it on Glama/Smithery/PulseMCP, plus publish .well-known/mcp.json — the largest remaining discovery gap for an otherwise agent-ready API.
  2. 02Add an llms-full.txt with the full docs content inlined so agents can ingest the complete Developer Center in one fetch.
  3. 03Add AGENTS.md to the primary SheerID GitHub repos (e.g. the JS library) with integration context for coding agents.
  4. 04Add multi-language code samples (curl/Node/Python) alongside the raw HTTP examples in the quickstart and endpoint reference — currently examples are HTTP/JSON only.
  5. 05Publish concrete rate-limit numbers (requests/sec and the Retry-After behavior) rather than only naming apiRateLimitExceeded.

Execution coverage · INFORMATIONAL, UNSCORED

Whether an agent can actually complete a call and recover from errors is the deeper Audit layer — documented here, but not part of the Discry Score.

API key (static bearer token, deprecated Aug 1 2026)OAuth2 dynamic tokens (Applications) Error format documented Rate limits documented Pagination documented Idempotency documented

Execution behavior is unusually well documented: machine-readable errorIds with an explicit per-429 retry table, an 11-second response-timeout recommendation, explicit non-idempotency of POST /verification with verificationId-reuse guidance, and webhook signature verification with retry/idempotent-handler notes. Specific numeric rate limits are not published, and the flow-based API has no documented pagination scheme.

See your own Discry Score.

Drop your API docs URL. See what an agent sees — in 60 seconds, free.

Discry your API — free